docusaurus-theme-openapi-docs 5.0.1 → 5.1.0

package/lib/theme/TabItem/index.js

@@ -0,0 +1,51 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = TabItem;
+const react_1 = __importDefault(require("react"));
+const clsx_1 = __importDefault(require("clsx"));
+const tabsUtils_1 = require("@theme/utils/tabsUtils");
+const styles_module_css_1 = __importDefault(require("./styles.module.css"));
+function TabItemPanel({ children, className, hidden }) {
+  return react_1.default.createElement(
+    "div",
+    {
+      role: "tabpanel",
+      className: (0, clsx_1.default)(
+        styles_module_css_1.default.tabItem,
+        className
+      ),
+      hidden,
+    },
+    children
+  );
+}
+function TabItem({ children, className, value }) {
+  const { selectedValue, lazy } = (0, tabsUtils_1.useTabs)();
+  const isSelected = value === selectedValue;
+  if (!isSelected && lazy) {
+    return null;
+  }
+  return react_1.default.createElement(
+    TabItemPanel,
+    { className: className, hidden: !isSelected },
+    children
+  );
+}

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

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

package/lib/theme/Tabs/index.d.ts

@@ -0,0 +1,5 @@
+import { type ReactNode } from "react";
+import { type TabsProps } from "@theme/utils/tabsUtils";
+type Props = TabsProps;
+export default function Tabs(props: Props): ReactNode;
+export {};

package/lib/theme/Tabs/index.js

@@ -0,0 +1,148 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = Tabs;
+const react_1 = __importDefault(require("react"));
+const theme_common_1 = require("@docusaurus/theme-common");
+const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
+const clsx_1 = __importDefault(require("clsx"));
+const scrollUtils_1 = require("@theme/utils/scrollUtils");
+const tabsUtils_1 = require("@theme/utils/tabsUtils");
+const styles_module_css_1 = __importDefault(require("./styles.module.css"));
+function TabList({ className }) {
+  const { selectedValue, selectValue, tabValues, block } = (0,
+  tabsUtils_1.useTabs)();
+  const tabRefs = [];
+  const { blockElementScrollPositionUntilNextRender } = (0,
+  scrollUtils_1.useScrollPositionBlocker)();
+  const handleTabChange = (event) => {
+    const newTab = event.currentTarget;
+    const newTabIndex = tabRefs.indexOf(newTab);
+    const newTabValue = tabValues[newTabIndex].value;
+    if (newTabValue !== selectedValue) {
+      blockElementScrollPositionUntilNextRender(newTab);
+      selectValue(newTabValue);
+    }
+  };
+  const handleKeydown = (event) => {
+    let focusElement = 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 react_1.default.createElement(
+    "ul",
+    {
+      role: "tablist",
+      "aria-orientation": "horizontal",
+      className: (0, clsx_1.default)(
+        "tabs",
+        {
+          "tabs--block": block,
+        },
+        className
+      ),
+    },
+    tabValues.map(({ value, label, attributes }) =>
+      react_1.default.createElement(
+        "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: (0, clsx_1.default)(
+            "tabs__item",
+            styles_module_css_1.default.tabItem,
+            attributes?.className,
+            {
+              "tabs__item--active": selectedValue === value,
+            }
+          ),
+        },
+        label ?? value
+      )
+    )
+  );
+}
+function TabContent({ children }) {
+  return react_1.default.createElement(
+    "div",
+    { className: "margin-top--md" },
+    children
+  );
+}
+function TabsContainer({ className, children }) {
+  return react_1.default.createElement(
+    "div",
+    {
+      className: (0, clsx_1.default)(
+        theme_common_1.ThemeClassNames.tabs.container,
+        // former name kept for backward compatibility
+        // see https://github.com/facebook/docusaurus/pull/4086
+        "tabs-container",
+        styles_module_css_1.default.tabList
+      ),
+    },
+    react_1.default.createElement(TabList, { className: className }),
+    react_1.default.createElement(TabContent, null, children)
+  );
+}
+function Tabs(props) {
+  const isBrowser = (0, useIsBrowser_1.default)();
+  const value = (0, tabsUtils_1.useTabsContextValue)(props);
+  return react_1.default.createElement(
+    tabsUtils_1.TabsProvider,
+    {
+      value: value,
+      // Remount tabs after hydration
+      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+      key: String(isBrowser),
+    },
+    react_1.default.createElement(
+      TabsContainer,
+      { className: props.className },
+      (0, tabsUtils_1.sanitizeTabsChildren)(props.children)
+    )
+  );
+}

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

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

package/lib/theme/styles.scss

@@ -32,6 +32,7 @@
 /* Schema Styling */
 @use "./ParamsItem/ParamsItem";
 @use "./SchemaItem/SchemaItem";
+@use "./SchemaExpansion/SchemaExpansion";
 /* Tabs Styling */
 @use "./ApiTabs/ApiTabs";
 @use "./DiscriminatorTabs/DiscriminatorTabs";

package/lib/theme/translationIds.d.ts

@@ -1,93 +1 @@
-export declare const OPENAPI_RESPONSE: {
-    TITLE: string;
-    CLEAR: string;
-    PLACEHOLDER: string;
-    HEADERS_TAB: string;
-};
-export declare const OPENAPI_TABS: {
-    RESPONSES_LABEL: string;
-};
-export declare const OPENAPI_REQUEST: {
-    BODY_TITLE: string;
-    ACCEPT_TITLE: string;
-    SEND_BUTTON: string;
-    REQUIRED_LABEL: string;
-    REQUEST_TITLE: string;
-    COLLAPSE_ALL: string;
-    EXPAND_ALL: string;
-    BASE_URL_TITLE: string;
-    AUTH_TITLE: string;
-    PARAMETERS_TITLE: string;
-    FETCHING_MESSAGE: string;
-    CONNECTION_FAILED: string;
-    ERROR_TIMEOUT: string;
-    ERROR_NETWORK: string;
-    ERROR_CORS: string;
-    ERROR_UNKNOWN: string;
-};
-export declare const OPENAPI_SERVER: {
-    EDIT_BUTTON: string;
-    HIDE_BUTTON: string;
-};
-export declare const OPENAPI_PARAM_OPTIONS: {
-    SHOW_OPTIONAL: string;
-    HIDE_OPTIONAL: string;
-};
-export declare const OPENAPI_FORM_FILE_UPLOAD: {
-    CLEAR_BUTTON: string;
-};
-export declare const OPENAPI_FORM: {
-    FIELD_REQUIRED: string;
-};
-export declare const OPENAPI_AUTH: {
-    BEARER_TOKEN: string;
-    USERNAME: string;
-    PASSWORD: string;
-    SECURITY_SCHEME: string;
-};
-export declare const OPENAPI_RESPONSE_EXAMPLES: {
-    EXAMPLE: string;
-    AUTO_EXAMPLE: string;
-};
-export declare const OPENAPI_BODY: {
-    EXAMPLE_FROM_SCHEMA: string;
-};
-export declare const OPENAPI_STATUS_CODES: {
-    RESPONSE_HEADERS: string;
-    SCHEMA_TITLE: string;
-};
-export declare const OPENAPI_SCHEMA: {
-    NO_SCHEMA: string;
-};
-export declare const OPENAPI_SCHEMA_ITEM: {
-    CHARACTERS: string;
-    NON_EMPTY: string;
-    REQUIRED: string;
-    DEPRECATED: string;
-    NULLABLE: string;
-    DEFAULT_VALUE: string;
-    EXAMPLE: string;
-    EXAMPLES: string;
-    DESCRIPTION: string;
-    CONSTANT_VALUE: string;
-    ENUM_VALUE: string;
-    ENUM_DESCRIPTION: string;
-    POSSIBLE_VALUES: string;
-    EXPRESSION: string;
-    ONE_OF: string;
-    ANY_OF: string;
-};
-export declare const OPENAPI_PARAMS_DETAILS: {
-    PARAMETERS_TITLE: string;
-};
-export declare const OPENAPI_SECURITY_SCHEMES: {
-    NAME: string;
-    TYPE: string;
-    SCOPES: string;
-    IN: string;
-    FLOWS: string;
-    DESCRIPTION: string;
-    SCHEME: string;
-    BEARER_FORMAT: string;
-    OPEN_ID_CONNECT_URL: string;
-};
+export {};

package/lib/theme/translationIds.js

@@ -6,112 +6,3 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OPENAPI_SECURITY_SCHEMES =
-  exports.OPENAPI_PARAMS_DETAILS =
-  exports.OPENAPI_SCHEMA_ITEM =
-  exports.OPENAPI_SCHEMA =
-  exports.OPENAPI_STATUS_CODES =
-  exports.OPENAPI_BODY =
-  exports.OPENAPI_RESPONSE_EXAMPLES =
-  exports.OPENAPI_AUTH =
-  exports.OPENAPI_FORM =
-  exports.OPENAPI_FORM_FILE_UPLOAD =
-  exports.OPENAPI_PARAM_OPTIONS =
-  exports.OPENAPI_SERVER =
-  exports.OPENAPI_REQUEST =
-  exports.OPENAPI_TABS =
-  exports.OPENAPI_RESPONSE =
-    void 0;
-exports.OPENAPI_RESPONSE = {
-  TITLE: "theme.openapi.response.title",
-  CLEAR: "theme.openapi.response.clear",
-  PLACEHOLDER: "theme.openapi.response.placeholder",
-  HEADERS_TAB: "theme.openapi.response.headersTab",
-};
-exports.OPENAPI_TABS = {
-  RESPONSES_LABEL: "theme.openapi.tabs.responses.label",
-};
-exports.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",
-  ERROR_TIMEOUT: "theme.openapi.request.error.timeout",
-  ERROR_NETWORK: "theme.openapi.request.error.network",
-  ERROR_CORS: "theme.openapi.request.error.cors",
-  ERROR_UNKNOWN: "theme.openapi.request.error.unknown",
-};
-exports.OPENAPI_SERVER = {
-  EDIT_BUTTON: "theme.openapi.server.editButton",
-  HIDE_BUTTON: "theme.openapi.server.hideButton",
-};
-exports.OPENAPI_PARAM_OPTIONS = {
-  SHOW_OPTIONAL: "theme.openapi.paramOptions.showOptional",
-  HIDE_OPTIONAL: "theme.openapi.paramOptions.hideOptional",
-};
-exports.OPENAPI_FORM_FILE_UPLOAD = {
-  CLEAR_BUTTON: "theme.openapi.formFileUpload.clearButton",
-};
-exports.OPENAPI_FORM = {
-  FIELD_REQUIRED: "theme.openapi.form.fieldRequired",
-};
-exports.OPENAPI_AUTH = {
-  BEARER_TOKEN: "theme.openapi.auth.bearerToken",
-  USERNAME: "theme.openapi.auth.username",
-  PASSWORD: "theme.openapi.auth.password",
-  SECURITY_SCHEME: "theme.openapi.auth.securityScheme",
-};
-exports.OPENAPI_RESPONSE_EXAMPLES = {
-  EXAMPLE: "theme.openapi.responseExamples.example",
-  AUTO_EXAMPLE: "theme.openapi.responseExamples.autoExample",
-};
-exports.OPENAPI_BODY = {
-  EXAMPLE_FROM_SCHEMA: "theme.openapi.body.exampleFromSchema",
-};
-exports.OPENAPI_STATUS_CODES = {
-  RESPONSE_HEADERS: "theme.openapi.statusCodes.responseHeaders",
-  SCHEMA_TITLE: "theme.openapi.statusCodes.schemaTitle",
-};
-exports.OPENAPI_SCHEMA = {
-  NO_SCHEMA: "theme.openapi.schema.noSchema",
-};
-exports.OPENAPI_SCHEMA_ITEM = {
-  CHARACTERS: "theme.openapi.schemaItem.characters",
-  NON_EMPTY: "theme.openapi.schemaItem.nonEmpty",
-  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",
-  EXPRESSION: "theme.openapi.schemaItem.expression",
-  ONE_OF: "theme.openapi.schemaItem.oneOf",
-  ANY_OF: "theme.openapi.schemaItem.anyOf",
-};
-exports.OPENAPI_PARAMS_DETAILS = {
-  PARAMETERS_TITLE: "theme.openapi.paramsDetails.parametersTitle",
-};
-exports.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/lib/theme/utils/codeBlockUtils.d.ts

@@ -0,0 +1,28 @@
+import type { CSSProperties } from "react";
+import type { PrismTheme } from "prism-react-renderer";
+export type MagicCommentConfig = {
+    className: string;
+    line?: string;
+    block?: {
+        start: string;
+        end: string;
+    };
+};
+export declare function parseCodeBlockTitle(metastring?: string): string;
+export declare function containsLineNumbers(metastring?: string): boolean;
+type ParseCodeLinesParam = {
+    metastring: string | undefined;
+    language: string | undefined;
+    magicComments: MagicCommentConfig[];
+};
+type CodeLineClassNames = {
+    [lineIndex: number]: string[];
+};
+type ParsedCodeLines = {
+    code: string;
+    lineClassNames: CodeLineClassNames;
+};
+export declare function parseLines(code: string, params: ParseCodeLinesParam): ParsedCodeLines;
+declare function parseClassNameLanguage(className: string | undefined): string | undefined;
+export { parseClassNameLanguage as parseLanguage };
+export declare function getPrismCssVariables(prismTheme: PrismTheme): CSSProperties;

package/lib/theme/utils/codeBlockUtils.js

@@ -0,0 +1,223 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseCodeBlockTitle = parseCodeBlockTitle;
+exports.containsLineNumbers = containsLineNumbers;
+exports.parseLines = parseLines;
+exports.parseLanguage = parseClassNameLanguage;
+exports.getPrismCssVariables = getPrismCssVariables;
+const parse_numeric_range_1 = __importDefault(require("parse-numeric-range"));
+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: "-->" },
+};
+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: "" },
+};
+const popularCommentTypes = Object.keys(popularCommentPatterns);
+function getCommentPattern(languages, magicCommentDirectives) {
+  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, magicCommentDirectives) {
+  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);
+  }
+}
+function parseCodeBlockTitle(metastring) {
+  return metastring?.match(codeBlockTitleRegex)?.groups.title ?? "";
+}
+function containsLineNumbers(metastring) {
+  return Boolean(metastring?.includes("showLineNumbers"));
+}
+function parseCodeLinesFromMetastring(code, { metastring, magicComments }) {
+  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 = (0, parse_numeric_range_1.default)(linesRange)
+      .filter((n) => n > 0)
+      .map((n) => [n - 1, [metastringRangeClassName]]);
+    return { lineClassNames: Object.fromEntries(lines), code };
+  }
+  return null;
+}
+function parseCodeLinesFromContent(code, params) {
+  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 = Object.fromEntries(
+    magicComments
+      .filter((d) => d.line)
+      .map(({ className, line }) => [line, className])
+  );
+  const blockStartToClassName = Object.fromEntries(
+    magicComments
+      .filter((d) => d.block)
+      .map(({ className, block }) => [block.start, className])
+  );
+  const blockEndToClassName = 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) => 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 = {};
+  Object.entries(blocks).forEach(([className, { range }]) => {
+    (0, parse_numeric_range_1.default)(range).forEach((l) => {
+      lineClassNames[l] ??= [];
+      lineClassNames[l].push(className);
+    });
+  });
+  return { code: lines.join("\n"), lineClassNames };
+}
+function parseLines(code, params) {
+  const newCode = code.replace(/\r?\n$/, "");
+  return (
+    parseCodeLinesFromMetastring(newCode, { ...params }) ??
+    parseCodeLinesFromContent(newCode, { ...params })
+  );
+}
+function parseClassNameLanguage(className) {
+  if (!className) {
+    return undefined;
+  }
+  const languageClassName = className
+    .split(" ")
+    .find((str) => str.startsWith("language-"));
+  return languageClassName?.replace(/language-/, "");
+}
+function getPrismCssVariables(prismTheme) {
+  const mapping = {
+    color: "--prism-color",
+    backgroundColor: "--prism-background-color",
+  };
+  const properties = {};
+  Object.entries(prismTheme.plain).forEach(([key, value]) => {
+    const varName = mapping[key];
+    if (varName && typeof value === "string") {
+      properties[varName] = value;
+    }
+  });
+  return properties;
+}

package/lib/theme/utils/reactUtils.d.ts

@@ -0,0 +1 @@
+export declare function useShallowMemoObject<O extends object>(obj: O): O;