docusaurus-theme-openapi-docs 0.0.0-361 → 0.0.0-362

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-361",
+  "version": "0.0.0-362",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -31,8 +31,8 @@
     "format:lib-next": "prettier --config ../../.prettierrc.json --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.18",
-    "@docusaurus/types": "2.0.0-beta.18",
+    "@docusaurus/module-type-aliases": "2.0.0-beta.21",
+    "@docusaurus/types": "2.0.0-beta.21",
     "@types/concurrently": "^6.3.0",
     "@types/crypto-js": "^4.1.0",
     "@types/fs-extra": "^9.0.13",
@@ -42,7 +42,7 @@
     "concurrently": "^5.2.0"
   },
   "dependencies": {
-    "@docusaurus/theme-common": "2.0.0-beta.18",
+    "@docusaurus/theme-common": "2.0.0-beta.21",
     "@mdx-js/react": "^1.6.21",
     "@monaco-editor/react": "^4.3.1",
     "@paloaltonetworks/postman-code-generators": "1.1.5-hotfix.5",
@@ -51,7 +51,7 @@
     "buffer": "^6.0.3",
     "clsx": "^1.1.1",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "0.0.0-361",
+    "docusaurus-plugin-openapi-docs": "0.0.0-362",
     "immer": "^9.0.7",
     "lodash": "^4.17.20",
     "monaco-editor": "^0.31.1",
@@ -70,5 +70,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "e87c5db5b36a32b85f7ba0aaea0a0280be498954"
+  "gitHead": "b887778ce634dfbc7f723721ffacef03679cec7e"
 }

package/src/theme/ApiItem/index.tsx

@@ -15,7 +15,7 @@ import {
   useWindowSize,
 } from "@docusaurus/theme-common";
 import DocBreadcrumbs from "@theme/DocBreadcrumbs";
-import type { Props, FrontMatter } from "@theme/DocItem";
+import type { Props } from "@theme/DocItem";
 import DocItemFooter from "@theme/DocItemFooter";
 import DocPaginator from "@theme/DocPaginator";
 import DocVersionBadge from "@theme/DocVersionBadge";
@@ -27,6 +27,7 @@ import TOCCollapsible from "@theme/TOCCollapsible";
 import clsx from "clsx";
 import type { ApiItem as ApiItemType } from "docusaurus-plugin-openapi-docs/lib/types";
 
+import { DocFrontMatter } from "../../types";
 import styles from "./styles.module.css";
 
 let ApiDemoPanel = (_: { item: any }) => <div style={{ marginTop: "3.5em" }} />;
@@ -34,7 +35,7 @@ if (ExecutionEnvironment.canUseDOM) {
   ApiDemoPanel = require("@theme/ApiDemoPanel").default;
 }
 
-interface ApiFrontMatter extends FrontMatter {
+interface ApiFrontMatter extends DocFrontMatter {
   readonly api?: ApiItemType;
 }
 

package/src/types.ts

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
+import type { FrontMatterTag } from "@docusaurus/utils";
 import type { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
 
 export interface ThemeConfig {
@@ -68,3 +69,112 @@ export interface ExternalDocumentationObject {
   description?: string;
   url: string;
 }
+
+export type FileChange = {
+  author?: string;
+  /** Date can be any
+   * [parsable date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
+   */
+  date?: Date | string;
+};
+
+export type DocFrontMatter = {
+  /**
+   * The last part of the doc ID (will be refactored in the future to be the
+   * full ID instead)
+   * @see {@link DocMetadata.id}
+   */
+  id?: string;
+  /**
+   * Will override the default title collected from h1 heading.
+   * @see {@link DocMetadata.title}
+   */
+  title?: string;
+  /**
+   * Front matter tags, unnormalized.
+   * @see {@link DocMetadata.tags}
+   */
+  tags?: FrontMatterTag[];
+  /**
+   * If there isn't a Markdown h1 heading (which, if there is, we don't
+   * remove), this front matter will cause the front matter title to not be
+   * displayed in the doc page.
+   */
+  hide_title?: boolean;
+  /** Hide the TOC on the right. */
+  hide_table_of_contents?: boolean;
+  /** Used in the head meta. */
+  keywords?: string[];
+  /** Used in the head meta. Should use `assets.image` in priority. */
+  image?: string;
+  /**
+   * Will override the default excerpt.
+   * @see {@link DocMetadata.description}
+   */
+  description?: string;
+  /**
+   * Custom slug appended after /<baseUrl>/<routeBasePath>/<versionPath>
+   * @see {@link DocMetadata.slug}
+   */
+  slug?: string;
+  /** Customizes the sidebar label for this doc. Will default to its title. */
+  sidebar_label?: string;
+  /**
+   * Controls the position of a doc inside the generated sidebar slice when
+   * using autogenerated sidebar items.
+   *
+   * @see https://docusaurus.io/docs/sidebar#autogenerated-sidebar-metadata
+   */
+  sidebar_position?: number;
+  /**
+   * Gives the corresponding sidebar label a special class name when using
+   * autogenerated sidebars.
+   */
+  sidebar_class_name?: string;
+  /**
+   * Will be propagated to the final sidebars data structure. Useful if you
+   * have swizzled sidebar-related code or simply querying doc data through
+   * sidebars.
+   */
+  sidebar_custom_props?: { [key: string]: unknown };
+  /**
+   * Changes the sidebar association of the current doc. Use `null` to make
+   * the current doc not associated to any sidebar.
+   */
+  displayed_sidebar?: string | null;
+  /**
+   * Customizes the pagination label for this doc. Will default to the sidebar
+   * label.
+   */
+  pagination_label?: string;
+  /** Overrides the default URL computed for this doc. */
+  custom_edit_url?: string | null;
+  /**
+   * Whether number prefix parsing is disabled on this doc.
+   * @see https://docusaurus.io/docs/sidebar#using-number-prefixes
+   */
+  parse_number_prefixes?: boolean;
+  /**
+   * Minimum TOC heading level. Must be between 2 and 6 and lower or equal to
+   * the max value.
+   */
+  toc_min_heading_level?: number;
+  /** Maximum TOC heading level. Must be between 2 and 6. */
+  toc_max_heading_level?: number;
+  /**
+   * The ID of the documentation you want the "Next" pagination to link to.
+   * Use `null` to disable showing "Next" for this page.
+   * @see {@link DocMetadata.next}
+   */
+  pagination_next?: string | null;
+  /**
+   * The ID of the documentation you want the "Previous" pagination to link
+   * to. Use `null` to disable showing "Previous" for this page.
+   * @see {@link DocMetadata.prev}
+   */
+  pagination_prev?: string | null;
+  /** Should this doc be excluded from production builds? */
+  draft?: boolean;
+  /** Allows overriding the last updated author and/or date. */
+  last_update?: FileChange;
+};