docusaurus-theme-openapi-docs 0.0.0-1295 → 0.0.0-1313

package/src/theme/TabItem/index.tsx

@@ -0,0 +1,61 @@
+/* ============================================================================
+ * Portions Copyright (c) Meta Platforms, Inc. and affiliates.
+ * Portions Copyright (c) Palo Alto Networks
+ *
+ * Swizzled from @docusaurus/theme-classic/src/theme/TabItem/index.tsx (MIT).
+ * Re-points useTabs to our vendored tabsUtils so that <TabItem> reads the same
+ * context our swizzled <Tabs> and OpenAPI tab variants (ApiTabs, MimeTabs,
+ * SchemaTabs, etc.) provide. See:
+ * https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/1140
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import React, { type ReactNode } from "react";
+
+import clsx from "clsx";
+
+import { type TabItemProps, useTabs } from "@theme/utils/tabsUtils";
+
+type Props = TabItemProps;
+import styles from "./styles.module.css";
+
+function TabItemPanel({
+  children,
+  className,
+  hidden,
+}: {
+  children: ReactNode;
+  className?: string;
+  hidden?: boolean;
+}) {
+  return (
+    <div
+      role="tabpanel"
+      className={clsx(styles.tabItem, className)}
+      {...{ hidden }}
+    >
+      {children}
+    </div>
+  );
+}
+
+export default function TabItem({
+  children,
+  className,
+  value,
+}: Props): ReactNode {
+  const { selectedValue, lazy } = useTabs();
+  const isSelected = value === selectedValue;
+
+  if (!isSelected && lazy) {
+    return null;
+  }
+
+  return (
+    <TabItemPanel className={className} hidden={!isSelected}>
+      {children}
+    </TabItemPanel>
+  );
+}

package/src/theme/TabItem/styles.module.css

@@ -0,0 +1,3 @@
+.tabItem > *:last-child {
+  margin-bottom: 0;
+}

package/src/theme/Tabs/index.tsx

@@ -0,0 +1,164 @@
+/* ============================================================================
+ * Portions Copyright (c) Meta Platforms, Inc. and affiliates.
+ * Portions Copyright (c) Palo Alto Networks
+ *
+ * Swizzled from @docusaurus/theme-classic/src/theme/Tabs/index.tsx (MIT).
+ * Re-points the internal hooks (useTabs, useTabsContextValue, etc.) to our
+ * vendored tabsUtils so that the entire <Tabs>/<TabItem> pair runs through a
+ * single React context owned by this package. See:
+ * https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/1140
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import React, { type ReactNode } from "react";
+
+import { ThemeClassNames } from "@docusaurus/theme-common";
+import useIsBrowser from "@docusaurus/useIsBrowser";
+import clsx from "clsx";
+
+import { useScrollPositionBlocker } from "@theme/utils/scrollUtils";
+import {
+  sanitizeTabsChildren,
+  type TabsProps,
+  TabsProvider,
+  useTabs,
+  useTabsContextValue,
+} from "@theme/utils/tabsUtils";
+import styles from "./styles.module.css";
+
+type Props = TabsProps;
+
+function TabList({ className }: { className?: string }) {
+  const { selectedValue, selectValue, tabValues, block } = useTabs();
+
+  const tabRefs: (HTMLLIElement | null)[] = [];
+  const { blockElementScrollPositionUntilNextRender } =
+    useScrollPositionBlocker();
+
+  const handleTabChange = (
+    event:
+      | React.FocusEvent<HTMLLIElement>
+      | React.MouseEvent<HTMLLIElement>
+      | React.KeyboardEvent<HTMLLIElement>
+  ) => {
+    const newTab = event.currentTarget;
+    const newTabIndex = tabRefs.indexOf(newTab);
+    const newTabValue = tabValues[newTabIndex]!.value;
+
+    if (newTabValue !== selectedValue) {
+      blockElementScrollPositionUntilNextRender(newTab);
+      selectValue(newTabValue);
+    }
+  };
+
+  const handleKeydown = (event: React.KeyboardEvent<HTMLLIElement>) => {
+    let focusElement: HTMLLIElement | null = null;
+
+    switch (event.key) {
+      case "Enter": {
+        handleTabChange(event);
+        break;
+      }
+      case "ArrowRight": {
+        const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
+        focusElement = tabRefs[nextTab] ?? tabRefs[0]!;
+        break;
+      }
+      case "ArrowLeft": {
+        const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
+        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1]!;
+        break;
+      }
+      default:
+        break;
+    }
+
+    focusElement?.focus();
+  };
+
+  return (
+    <ul
+      role="tablist"
+      aria-orientation="horizontal"
+      className={clsx(
+        "tabs",
+        {
+          "tabs--block": block,
+        },
+        className
+      )}
+    >
+      {tabValues.map(({ value, label, attributes }) => (
+        <li
+          // TODO extract TabListItem
+          role="tab"
+          tabIndex={selectedValue === value ? 0 : -1}
+          aria-selected={selectedValue === value}
+          key={value}
+          ref={(ref) => {
+            tabRefs.push(ref);
+          }}
+          onKeyDown={handleKeydown}
+          onClick={handleTabChange}
+          {...attributes}
+          className={clsx(
+            "tabs__item",
+            styles.tabItem,
+            attributes?.className as string,
+            {
+              "tabs__item--active": selectedValue === value,
+            }
+          )}
+        >
+          {label ?? value}
+        </li>
+      ))}
+    </ul>
+  );
+}
+
+function TabContent({ children }: { children: ReactNode }) {
+  return <div className="margin-top--md">{children}</div>;
+}
+
+function TabsContainer({
+  className,
+  children,
+}: {
+  className?: string;
+  children: ReactNode;
+}): ReactNode {
+  return (
+    <div
+      className={clsx(
+        ThemeClassNames.tabs.container,
+        // former name kept for backward compatibility
+        // see https://github.com/facebook/docusaurus/pull/4086
+        "tabs-container",
+        styles.tabList
+      )}
+    >
+      <TabList className={className} />
+      <TabContent>{children}</TabContent>
+    </div>
+  );
+}
+
+export default function Tabs(props: Props): ReactNode {
+  const isBrowser = useIsBrowser();
+  const value = useTabsContextValue(props);
+  return (
+    <TabsProvider
+      value={value}
+      // Remount tabs after hydration
+      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+      key={String(isBrowser)}
+    >
+      <TabsContainer className={props.className}>
+        {sanitizeTabsChildren(props.children)}
+      </TabsContainer>
+    </TabsProvider>
+  );
+}

package/src/theme/Tabs/styles.module.css

@@ -0,0 +1,7 @@
+.tabList {
+  margin-bottom: var(--ifm-leading);
+}
+
+.tabItem {
+  margin-top: 0 !important;
+}

package/src/theme/utils/codeBlockUtils.ts

@@ -0,0 +1,296 @@
+/* ============================================================================
+ * Portions Copyright (c) Meta Platforms, Inc. and affiliates.
+ * Portions Copyright (c) Palo Alto Networks
+ *
+ * Vendored subset of @docusaurus/theme-common/src/utils/codeBlockUtils.tsx (MIT)
+ * to remove the dependency on @docusaurus/theme-common/internal.
+ * See: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/1140
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import type { CSSProperties } from "react";
+
+import rangeParser from "parse-numeric-range";
+import type { PrismTheme, PrismThemeEntry } from "prism-react-renderer";
+
+const codeBlockTitleRegex = /title=(?<quote>["'])(?<title>.*?)\1/;
+const metastringLinesRangeRegex = /\{(?<range>[\d,-]+)\}/;
+
+const popularCommentPatterns = {
+  js: { start: "\\/\\/", end: "" },
+  jsBlock: { start: "\\/\\*", end: "\\*\\/" },
+  jsx: { start: "\\{\\s*\\/\\*", end: "\\*\\/\\s*\\}" },
+  bash: { start: "#", end: "" },
+  html: { start: "<!--", end: "-->" },
+} as const;
+
+const commentPatterns = {
+  ...popularCommentPatterns,
+  lua: { start: "--", end: "" },
+  wasm: { start: "\\;\\;", end: "" },
+  tex: { start: "%", end: "" },
+  vb: { start: "['‘’]", end: "" },
+  vbnet: { start: "(?:_\\s*)?['‘’]", end: "" },
+  rem: { start: "[Rr][Ee][Mm]\\b", end: "" },
+  f90: { start: "!", end: "" },
+  ml: { start: "\\(\\*", end: "\\*\\)" },
+  cobol: { start: "\\*>", end: "" },
+} as const;
+
+type CommentType = keyof typeof commentPatterns;
+const popularCommentTypes = Object.keys(
+  popularCommentPatterns
+) as CommentType[];
+
+export type MagicCommentConfig = {
+  className: string;
+  line?: string;
+  block?: { start: string; end: string };
+};
+
+function getCommentPattern(
+  languages: CommentType[],
+  magicCommentDirectives: MagicCommentConfig[]
+) {
+  const commentPattern = languages
+    .map((lang) => {
+      const { start, end } = commentPatterns[lang];
+      return `(?:${start}\\s*(${magicCommentDirectives
+        .flatMap((d) => [d.line, d.block?.start, d.block?.end].filter(Boolean))
+        .join("|")})\\s*${end})`;
+    })
+    .join("|");
+  return new RegExp(`^\\s*(?:${commentPattern})\\s*$`);
+}
+
+function getAllMagicCommentDirectiveStyles(
+  lang: string,
+  magicCommentDirectives: MagicCommentConfig[]
+) {
+  switch (lang) {
+    case "js":
+    case "javascript":
+    case "ts":
+    case "typescript":
+      return getCommentPattern(["js", "jsBlock"], magicCommentDirectives);
+
+    case "jsx":
+    case "tsx":
+      return getCommentPattern(
+        ["js", "jsBlock", "jsx"],
+        magicCommentDirectives
+      );
+
+    case "html":
+      return getCommentPattern(
+        ["js", "jsBlock", "html"],
+        magicCommentDirectives
+      );
+
+    case "python":
+    case "py":
+    case "bash":
+      return getCommentPattern(["bash"], magicCommentDirectives);
+
+    case "markdown":
+    case "md":
+      return getCommentPattern(["html", "jsx", "bash"], magicCommentDirectives);
+
+    case "tex":
+    case "latex":
+    case "matlab":
+      return getCommentPattern(["tex"], magicCommentDirectives);
+
+    case "lua":
+    case "haskell":
+      return getCommentPattern(["lua"], magicCommentDirectives);
+
+    case "sql":
+      return getCommentPattern(["lua", "jsBlock"], magicCommentDirectives);
+
+    case "wasm":
+      return getCommentPattern(["wasm"], magicCommentDirectives);
+
+    case "vb":
+    case "vba":
+    case "visual-basic":
+      return getCommentPattern(["vb", "rem"], magicCommentDirectives);
+    case "vbnet":
+      return getCommentPattern(["vbnet", "rem"], magicCommentDirectives);
+
+    case "batch":
+      return getCommentPattern(["rem"], magicCommentDirectives);
+
+    case "basic":
+      return getCommentPattern(["rem", "f90"], magicCommentDirectives);
+
+    case "fsharp":
+      return getCommentPattern(["js", "ml"], magicCommentDirectives);
+
+    case "ocaml":
+    case "sml":
+      return getCommentPattern(["ml"], magicCommentDirectives);
+
+    case "fortran":
+      return getCommentPattern(["f90"], magicCommentDirectives);
+
+    case "cobol":
+      return getCommentPattern(["cobol"], magicCommentDirectives);
+
+    default:
+      return getCommentPattern(popularCommentTypes, magicCommentDirectives);
+  }
+}
+
+export function parseCodeBlockTitle(metastring?: string): string {
+  return metastring?.match(codeBlockTitleRegex)?.groups!.title ?? "";
+}
+
+export function containsLineNumbers(metastring?: string): boolean {
+  return Boolean(metastring?.includes("showLineNumbers"));
+}
+
+type ParseCodeLinesParam = {
+  metastring: string | undefined;
+  language: string | undefined;
+  magicComments: MagicCommentConfig[];
+};
+
+type CodeLineClassNames = { [lineIndex: number]: string[] };
+
+type ParsedCodeLines = {
+  code: string;
+  lineClassNames: CodeLineClassNames;
+};
+
+function parseCodeLinesFromMetastring(
+  code: string,
+  { metastring, magicComments }: ParseCodeLinesParam
+): ParsedCodeLines | null {
+  if (metastring && metastringLinesRangeRegex.test(metastring)) {
+    const linesRange = metastring.match(metastringLinesRangeRegex)!.groups!
+      .range!;
+    if (magicComments.length === 0) {
+      throw new Error(
+        `A highlight range has been given in code block's metastring (\`\`\` ${metastring}), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.`
+      );
+    }
+    const metastringRangeClassName = magicComments[0]!.className;
+    const lines = rangeParser(linesRange)
+      .filter((n) => n > 0)
+      .map((n) => [n - 1, [metastringRangeClassName]] as [number, string[]]);
+    return { lineClassNames: Object.fromEntries(lines), code };
+  }
+  return null;
+}
+
+function parseCodeLinesFromContent(
+  code: string,
+  params: ParseCodeLinesParam
+): ParsedCodeLines {
+  const { language, magicComments } = params;
+  if (language === undefined) {
+    return { lineClassNames: {}, code };
+  }
+  const directiveRegex = getAllMagicCommentDirectiveStyles(
+    language,
+    magicComments
+  );
+  const lines = code.split(/\r?\n/);
+  const blocks = Object.fromEntries(
+    magicComments.map((d) => [d.className, { start: 0, range: "" }])
+  );
+  const lineToClassName: { [comment: string]: string } = Object.fromEntries(
+    magicComments
+      .filter((d) => d.line)
+      .map(({ className, line }) => [line!, className] as [string, string])
+  );
+  const blockStartToClassName: { [comment: string]: string } =
+    Object.fromEntries(
+      magicComments
+        .filter((d) => d.block)
+        .map(({ className, block }) => [block!.start, className])
+    );
+  const blockEndToClassName: { [comment: string]: string } = Object.fromEntries(
+    magicComments
+      .filter((d) => d.block)
+      .map(({ className, block }) => [block!.end, className])
+  );
+  for (let lineNumber = 0; lineNumber < lines.length; ) {
+    const line = lines[lineNumber]!;
+    const match = line.match(directiveRegex);
+    if (!match) {
+      lineNumber += 1;
+      continue;
+    }
+    const directive = match
+      .slice(1)
+      .find((item: string | undefined) => item !== undefined)!;
+    if (lineToClassName[directive]) {
+      blocks[lineToClassName[directive]!]!.range += `${lineNumber},`;
+    } else if (blockStartToClassName[directive]) {
+      blocks[blockStartToClassName[directive]!]!.start = lineNumber;
+    } else if (blockEndToClassName[directive]) {
+      blocks[blockEndToClassName[directive]!]!.range += `${
+        blocks[blockEndToClassName[directive]!]!.start
+      }-${lineNumber - 1},`;
+    }
+    lines.splice(lineNumber, 1);
+  }
+
+  const lineClassNames: { [lineIndex: number]: string[] } = {};
+  Object.entries(blocks).forEach(([className, { range }]) => {
+    rangeParser(range).forEach((l) => {
+      lineClassNames[l] ??= [];
+      lineClassNames[l]!.push(className);
+    });
+  });
+
+  return { code: lines.join("\n"), lineClassNames };
+}
+
+export function parseLines(
+  code: string,
+  params: ParseCodeLinesParam
+): ParsedCodeLines {
+  const newCode = code.replace(/\r?\n$/, "");
+  return (
+    parseCodeLinesFromMetastring(newCode, { ...params }) ??
+    parseCodeLinesFromContent(newCode, { ...params })
+  );
+}
+
+function parseClassNameLanguage(
+  className: string | undefined
+): string | undefined {
+  if (!className) {
+    return undefined;
+  }
+  const languageClassName = className
+    .split(" ")
+    .find((str) => str.startsWith("language-"));
+  return languageClassName?.replace(/language-/, "");
+}
+
+// Upstream renamed `parseLanguage` to `parseClassNameLanguage`; the back-compat
+// shim in @docusaurus/theme-common/internal re-exports it under the old name.
+// We keep the old name here since our call sites still use it.
+export { parseClassNameLanguage as parseLanguage };
+
+export function getPrismCssVariables(prismTheme: PrismTheme): CSSProperties {
+  const mapping: PrismThemeEntry = {
+    color: "--prism-color",
+    backgroundColor: "--prism-background-color",
+  };
+
+  const properties: { [key: string]: string } = {};
+  Object.entries(prismTheme.plain).forEach(([key, value]) => {
+    const varName = mapping[key as keyof PrismThemeEntry];
+    if (varName && typeof value === "string") {
+      properties[varName] = value;
+    }
+  });
+  return properties;
+}

package/src/theme/utils/reactUtils.ts

@@ -0,0 +1,22 @@
+/* ============================================================================
+ * Portions Copyright (c) Meta Platforms, Inc. and affiliates.
+ * Portions Copyright (c) Palo Alto Networks
+ *
+ * Vendored from @docusaurus/theme-common/src/utils/reactUtils.tsx (MIT).
+ * Only useShallowMemoObject is kept here — it is not re-exported by
+ * @docusaurus/theme-common (public or /internal). useEvent and
+ * ReactContextError are public APIs imported directly from the package.
+ * See: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/1140
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import { useMemo } from "react";
+
+export function useShallowMemoObject<O extends object>(obj: O): O {
+  const deps = Object.entries(obj);
+  deps.sort((a, b) => a[0].localeCompare(b[0]));
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  return useMemo(() => obj, deps.flat());
+}