@rspress/shared 1.41.3 → 1.42.1-canary-20240226

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import type { loadConfig } from '@rsbuild/core';
 import type { PluggableList } from 'unified';
 import type { RsbuildConfig } from '@rsbuild/core';
 import type { RsbuildPlugin } from '@rsbuild/core';
@@ -17,13 +18,15 @@ export declare function addLeadingSlash(url: string): string;
 
 export declare function addTrailingSlash(url: string): string;
 
+export declare type AnyFunction = (...args: any[]) => any;
+
 export declare const APPEARANCE_KEY = "rspress-theme-appearance";
 
 export declare type BaseRuntimePageInfo = Omit<RemoveUnderscoreProps<PageIndexInfo>, 'id' | 'content' | 'domain'>;
 
 export declare const cleanUrl: (url: string) => string;
 
-export declare type Config = UserConfig | Promise<UserConfig> | ((env: any) => UserConfig | Promise<UserConfig>);
+export declare type Config = UserConfig | Promise<UserConfig> | ((...args: Parameters<typeof loadConfig>) => UserConfig | Promise<UserConfig>);
 
 export declare const DEFAULT_HIGHLIGHT_LANGUAGES: string[][];
 
@@ -203,7 +206,7 @@ export declare interface FrontMatterMeta {
     sidebar?: boolean;
     outline?: boolean;
     lineNumbers?: boolean;
-    overviewHeaders?: number;
+    overviewHeaders?: number[];
     titleSuffix?: string;
     head?: [string, Record<string, string>][];
     context?: string;
@@ -440,20 +443,20 @@ export declare interface PageData {
  * "_foo" is the private field that won't be written to search-index.json file
  * and should not be used in the runtime (usePageData).
  */
-export declare type PageIndexInfo = {
+export declare interface PageIndexInfo {
     id: number;
     title: string;
     routePath: string;
     toc: Header[];
     content: string;
     _html: string;
-    frontmatter: Record<string, unknown>;
+    frontmatter: FrontMatterMeta;
     lang: string;
     version: string;
     domain: string;
     _filepath: string;
     _relativePath: string;
-};
+}
 
 export declare interface PageModule<T extends React.ComponentType<unknown>> {
     default: T;
@@ -608,9 +611,7 @@ declare interface RspressPlugin {
     /**
      * Extend every page's data
      */
-    extendPageData?: (pageData: PageIndexInfo & {
-        [key: string]: unknown;
-    }, isProd: boolean) => void | Promise<void>;
+    extendPageData?: (pageData: PageIndexInfo, isProd: boolean) => void | Promise<void>;
     /**
      * Add custom route
      */
@@ -871,15 +872,15 @@ export declare interface UserConfig<ThemeConfig = DefaultThemeConfig> {
         /**
          * Whether to enable language parity checking
          */
-        enabled: boolean;
+        enabled?: boolean;
         /**
          * Directories to include in the parity check
          */
-        include: string[];
+        include?: string[];
         /**
          * Directories to exclude from the parity check
          */
-        exclude: string[];
+        exclude?: string[];
     };
 }
 

package/dist/node-utils.d.ts

@@ -1,3 +1,6 @@
+import { MdxJsxAttributeValueExpression } from 'mdast-util-mdx-jsx';
+import type { MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
+import type { MdxJsxTextElement } from 'mdast-util-mdx-jsx';
 import type { PluggableList } from 'unified';
 import type { RsbuildConfig } from '@rsbuild/core';
 import type { RsbuildPlugin } from '@rsbuild/core';
@@ -158,6 +161,19 @@ declare interface EditLink {
     text?: string;
 }
 
+/**
+ * hello world {#custom-id} -> { text: 'hello world', id: 'custom-id' }
+ */
+export declare const extractTextAndId: (title?: string) => [text: string, customId: string];
+
+declare interface Feature {
+    icon: string;
+    title: string;
+    details: string;
+    span?: number;
+    link?: string;
+}
+
 /**
  * The config of filter component
  */
@@ -171,6 +187,25 @@ declare interface Footer {
     message?: string;
 }
 
+declare interface FrontMatterMeta {
+    title?: string;
+    description?: string;
+    overview?: boolean;
+    pageType?: PageType;
+    features?: Feature[];
+    hero?: Hero;
+    sidebar?: boolean;
+    outline?: boolean;
+    lineNumbers?: boolean;
+    overviewHeaders?: number[];
+    titleSuffix?: string;
+    head?: [string, Record<string, string>][];
+    context?: string;
+    [key: string]: unknown;
+}
+
+export declare const getNodeAttribute: (node: MdxJsxFlowElement | MdxJsxTextElement, attrName: string) => string | MdxJsxAttributeValueExpression | null | undefined;
+
 declare interface Header {
     id: string;
     text: string;
@@ -178,7 +213,31 @@ declare interface Header {
     charIndex: number;
 }
 
-export declare function loadFrontMatter<TFrontmatter extends Record<string, unknown> = Record<string, string>>(source: string, filepath: string, root: string, outputWarning?: boolean): {
+declare interface Hero {
+    name: string;
+    text: string;
+    tagline: string;
+    image?: {
+        src: string | {
+            dark: string;
+            light: string;
+        };
+        alt: string;
+        /**
+         * `srcset` and `sizes` are attributes of `<img>` tag. Please refer to https://mdn.io/srcset for the usage.
+         * When the value is an array, rspress will join array members with commas.
+         **/
+        sizes?: string | string[];
+        srcset?: string | string[];
+    };
+    actions: {
+        text: string;
+        link: string;
+        theme: 'brand' | 'alt';
+    }[];
+}
+
+export declare function loadFrontMatter<TFrontmatter extends Record<string, unknown> = FrontMatterMeta>(source: string, filepath: string, root: string, outputWarning?: boolean): {
     frontmatter: TFrontmatter;
     content: string;
 };
@@ -311,20 +370,22 @@ declare interface NavItemWithLinkAndChildren {
  * "_foo" is the private field that won't be written to search-index.json file
  * and should not be used in the runtime (usePageData).
  */
-declare type PageIndexInfo = {
+declare interface PageIndexInfo {
     id: number;
     title: string;
     routePath: string;
     toc: Header[];
     content: string;
     _html: string;
-    frontmatter: Record<string, unknown>;
+    frontmatter: FrontMatterMeta;
     lang: string;
     version: string;
     domain: string;
     _filepath: string;
     _relativePath: string;
-};
+}
+
+declare type PageType = 'home' | 'doc' | 'custom' | '404' | 'blank';
 
 declare type RemoteSearchIndexInfo = string | {
     value: string;
@@ -417,9 +478,7 @@ declare interface RspressPlugin {
     /**
      * Extend every page's data
      */
-    extendPageData?: (pageData: PageIndexInfo & {
-        [key: string]: unknown;
-    }, isProd: boolean) => void | Promise<void>;
+    extendPageData?: (pageData: PageIndexInfo, isProd: boolean) => void | Promise<void>;
     /**
      * Add custom route
      */
@@ -642,15 +701,15 @@ declare interface UserConfig<ThemeConfig = Config> {
         /**
          * Whether to enable language parity checking
          */
-        enabled: boolean;
+        enabled?: boolean;
         /**
          * Directories to include in the parity check
          */
-        include: string[];
+        include?: string[];
         /**
          * Directories to exclude from the parity check
          */
-        exclude: string[];
+        exclude?: string[];
     };
 }
 

package/dist/node-utils.js

@@ -54,9 +54,25 @@ var __webpack_exports__ = {};
 (()=>{
     __webpack_require__.r(__webpack_exports__);
     __webpack_require__.d(__webpack_exports__, {
-        mergeDocConfig: ()=>mergeDocConfig,
-        loadFrontMatter: ()=>loadFrontMatter
+        extractTextAndId: ()=>extractTextAndId,
+        loadFrontMatter: ()=>loadFrontMatter,
+        getNodeAttribute: ()=>getNodeAttribute,
+        mergeDocConfig: ()=>mergeDocConfig
     });
+    const extractTextAndId = (title)=>{
+        if (!title) return [
+            '',
+            ''
+        ];
+        const customIdReg = /\\?{#.*}/;
+        const text = title.replace(customIdReg, '').trimEnd();
+        const customId = title.match(customIdReg)?.[0]?.slice(2, -1) || '';
+        return [
+            text,
+            customId
+        ];
+    };
+    const getNodeAttribute = (node, attrName)=>node.attributes.find((attr)=>'name' in attr && attr.name === attrName)?.value;
     const external_node_path_namespaceObject = require("node:path");
     var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
     const external_gray_matter_namespaceObject = require("gray-matter");

package/dist/node-utils.mjs

@@ -1,6 +1,20 @@
 import * as __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__ from "node:path";
 import * as __WEBPACK_EXTERNAL_MODULE_gray_matter_90c6cd0b__ from "gray-matter";
 import * as __WEBPACK_EXTERNAL_MODULE__rsbuild_core_1b356efc__ from "@rsbuild/core";
+const extractTextAndId = (title)=>{
+    if (!title) return [
+        '',
+        ''
+    ];
+    const customIdReg = /\\?{#.*}/;
+    const text = title.replace(customIdReg, '').trimEnd();
+    const customId = title.match(customIdReg)?.[0]?.slice(2, -1) || '';
+    return [
+        text,
+        customId
+    ];
+};
+const getNodeAttribute = (node, attrName)=>node.attributes.find((attr)=>'name' in attr && attr.name === attrName)?.value;
 function loadFrontMatter(source, filepath, root, outputWarning = false) {
     try {
         const { content, data } = (0, __WEBPACK_EXTERNAL_MODULE_gray_matter_90c6cd0b__["default"])(source);
@@ -33,4 +47,4 @@ const mergeDocConfig = async (...configs)=>{
         ];
     });
 };
-export { loadFrontMatter, mergeDocConfig };
+export { extractTextAndId, getNodeAttribute, loadFrontMatter, mergeDocConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "1.41.3",
+  "version": "1.42.1-canary-20240226",
   "repository": {
     "type": "git",
     "url": "https://github.com/web-infra-dev/rspress",
@@ -42,12 +42,13 @@
     "unified": "^10.1.2"
   },
   "devDependencies": {
-    "@rslib/core": "0.4.1",
+    "@rslib/core": "0.5.2",
     "@types/fs-extra": "11.0.4",
     "@types/jest": "~29.5.14",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^18.11.17",
     "@types/react": "^18.3.18",
+    "mdast-util-mdx-jsx": "^2.1.4",
     "medium-zoom": "1.1.0",
     "rimraf": "^3.0.2",
     "typescript": "^5.5.3"