@docusaurus/types 3.2.0 → 3.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/types",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Common types for Docusaurus packages.",
   "types": "./src/index.d.ts",
   "publishConfig": {
@@ -27,5 +27,5 @@
     "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
-  "gitHead": "5af143651b26b39761361acd96e9c5be7ba0cb25"
+  "gitHead": "2ec4e078b5ca0c57f2cc04f2fe564d524bb5e858"
 }

package/src/config.d.ts

@@ -45,6 +45,13 @@ export type ParseFrontMatter = (
   },
 ) => Promise<ParseFrontMatterResult>;
 
+export type MarkdownAnchorsConfig = {
+  /**
+   * Preserves the case of the heading text when generating anchor ids.
+   */
+  maintainCase: boolean;
+};
+
 export type MarkdownConfig = {
   /**
    * The Markdown format to use by default.
@@ -101,6 +108,11 @@ export type MarkdownConfig = {
    * See also https://github.com/remarkjs/remark-rehype#options
    */
   remarkRehypeOptions: RemarkRehypeOptions;
+
+  /**
+   * Options to control the behavior of anchors generated from Markdown headings
+   */
+  anchors: MarkdownAnchorsConfig;
 };
 
 /**

package/src/context.d.ts

@@ -7,7 +7,7 @@
 import type {DocusaurusConfig} from './config';
 import type {CodeTranslations, I18n} from './i18n';
 import type {LoadedPlugin, PluginVersionInformation} from './plugin';
-import type {RouteConfig} from './routing';
+import type {PluginRouteConfig} from './routing';
 
 export type DocusaurusContext = {
   siteConfig: DocusaurusConfig;
@@ -57,7 +57,7 @@ export type Props = LoadContext & {
   preBodyTags: string;
   postBodyTags: string;
   siteMetadata: SiteMetadata;
-  routes: RouteConfig[];
+  routes: PluginRouteConfig[];
   routesPaths: string[];
   plugins: LoadedPlugin[];
 };

package/src/index.d.ts

@@ -70,6 +70,7 @@ export {
 
 export {
   RouteConfig,
+  PluginRouteConfig,
   RouteMetadata,
   RouteContext,
   PluginRouteContext,

package/src/plugin.d.ts

@@ -49,7 +49,7 @@ export type PluginVersionInformation =
 
 export type PluginContentLoadedActions = {
   addRoute: (config: RouteConfig) => void;
-  createData: (name: string, data: string) => Promise<string>;
+  createData: (name: string, data: string | object) => Promise<string>;
   setGlobalData: (data: unknown) => void;
 };
 

package/src/routing.d.ts

@@ -6,6 +6,7 @@
  */
 
 import type {ParsedUrlQueryInput} from 'querystring';
+import type {PluginIdentifier} from './plugin';
 
 /**
  * A "module" represents a unit of serialized data emitted from the plugin. It
@@ -110,9 +111,23 @@ export type RouteConfig = {
    */
   metadata?: RouteMetadata;
   /**
-   * Extra props; will be available on the client side.
+   * Optional props object; will be converted to a module and injected as props
+   * into the route component.
    */
-  [propName: string]: unknown;
+  props?: {[propName: string]: unknown};
+  /**
+   * Extra route attribute; will be available on the client side route object.
+   */
+  [attributeName: string]: unknown;
+};
+
+export type PluginRouteConfig = RouteConfig & {
+  /**
+   * Routes are always created by Docusaurus plugins
+   * A plugin identifier is available at the top of a routing tree
+   * (child routes are implicitly created by the same plugin as their parent)
+   */
+  plugin: PluginIdentifier;
 };
 
 export type RouteContext = {