@rspress/shared 0.0.0-next-20240620083724 → 0.0.0-next-20241029080927

package/dist/index.d.ts

@@ -179,7 +179,7 @@ interface Config$1 {
     docFooter?: DocFooter;
     /**
      * The social links to be displayed at the end of the nav bar. Perfect for
-     * placing links to social services such as GitHub, Twitter, Facebook, etc.
+     * placing links to social services such as GitHub, X, Facebook, etc.
      */
     socialLinks?: SocialLink[];
     /**
@@ -218,14 +218,22 @@ interface Config$1 {
      * The text of suggested query text when no search result
      */
     searchSuggestedQueryText?: string;
+    /**
+     * The text of overview filter
+     */
+    overview?: FilterConfig;
     /**
      * The behavior of hiding navbar
      */
     hideNavbar?: 'always' | 'auto' | 'never';
     /**
-     * Whether to enable the animation for translation pages
+     * Whether to enable view transition animation for pages switching
      */
     enableContentAnimation?: boolean;
+    /**
+     * Whether to enable view transition animation for the theme
+     */
+    enableAppearanceAnimation?: boolean;
     /**
      * Enable scroll to top button on documentation
      * @default false
@@ -264,6 +272,15 @@ interface LocaleConfig {
     searchPlaceholderText?: string;
     searchNoResultsText?: string;
     searchSuggestedQueryText?: string;
+    overview?: FilterConfig;
+}
+/**
+ * The config of filter component
+ */
+interface FilterConfig {
+    filterNameText?: string;
+    filterPlaceholderText?: string;
+    filterNoResultText?: string;
 }
 type Nav = NavItem[] | {
     [key: string]: NavItem[];
@@ -356,7 +373,7 @@ interface SocialLink {
     mode: 'link' | 'text' | 'img' | 'dom';
     content: string;
 }
-type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'instagram' | 'linkedin' | 'slack' | 'twitter' | 'youtube' | 'wechat' | 'qq' | 'juejin' | 'zhihu' | 'bilibili' | 'weibo' | 'gitlab' | 'X' | {
+type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'instagram' | 'linkedin' | 'slack' | 'x' | 'youtube' | 'wechat' | 'qq' | 'juejin' | 'zhihu' | 'bilibili' | 'weibo' | 'gitlab' | 'X' | {
     svg: string;
 };
 interface Footer {
@@ -417,6 +434,9 @@ interface Locale {
     title?: string;
     description?: string;
 }
+type SSGConfig = boolean | {
+    strict?: boolean;
+};
 interface UserConfig<ThemeConfig = Config$1> {
     /**
      * The root directory of the site.
@@ -512,7 +532,7 @@ interface UserConfig<ThemeConfig = Config$1> {
     /**
      * Whether to enable ssg, default is true
      */
-    ssg?: boolean;
+    ssg?: SSGConfig;
     /**
      * Whether to enable medium-zoom, default is true
      */
@@ -538,7 +558,10 @@ interface UserConfig<ThemeConfig = Config$1> {
         versions: string[];
     };
 }
-type BaseRuntimePageInfo = Omit<PageIndexInfo, 'id' | 'content' | 'domain'>;
+type RemoveUnderscoreProps<T> = {
+    [K in keyof T as K extends `_${string}` ? never : K]: T[K];
+};
+type BaseRuntimePageInfo = Omit<RemoveUnderscoreProps<PageIndexInfo>, 'id' | 'content' | 'domain'>;
 interface SiteData<ThemeConfig = NormalizedConfig> {
     root: string;
     base: string;
@@ -570,12 +593,18 @@ interface SiteData<ThemeConfig = NormalizedConfig> {
         versions: string[];
     };
 }
+/**
+ * @description search-index.json file
+ * "_foo" is the private field that won't be written to search-index.json file
+ * and should not be used in the runtime (usePageData).
+ */
 type PageIndexInfo = {
     id: number;
     title: string;
     routePath: string;
     toc: Header[];
     content: string;
+    _html: string;
     frontmatter: Record<string, unknown>;
     lang: string;
     version: string;
@@ -651,7 +680,6 @@ interface PageData {
         lastUpdatedTime?: string;
         description?: string;
         pageType: PageType;
-        _relativePath: string;
         [key: string]: unknown;
     };
 }
@@ -791,4 +819,4 @@ declare function removeBase(url: string, base: string): string;
 declare function withoutHash(url: string): string;
 declare const mergeDocConfig: (...configs: UserConfig[]) => UserConfig;
 
-export { APPEARANCE_KEY, type AdditionalPage, type BaseRuntimePageInfo, type Config, DEFAULT_HIGHLIGHT_LANGUAGES, type Config$1 as DefaultThemeConfig, type DocFooter, type EditLink, type Feature, type Footer, type FrontMatterMeta, HASH_REGEXP, type Header, type Hero, type Image, type LocalSearchOptions, type Locale, type LocaleConfig, type LocaleLink, type LocaleLinks, MDX_REGEXP, type MarkdownOptions, type MdxRsOptions, type Nav, type NavItem, type NavItemWithChildren, type NavItemWithLink, type NavItemWithLinkAndChildren, type NormalizedConfig, type NormalizedConfig as NormalizedDefaultThemeConfig, type NormalizedLocales, type NormalizedSidebar, type NormalizedSidebarGroup, type PageData, type PageIndexInfo, type PageModule, type PageType, type RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, type RemotePageInfo, type RemoteSearchIndexInfo, type RemoteSearchOptions, type ReplaceRule, type Route, type RouteMeta, type RouteOptions, type RspressPlugin, SEARCH_INDEX_NAME, type SearchHooks, type SearchOptions, type Sidebar, type SidebarDivider, type SidebarGroup, type SidebarItem, type SidebarSectionHeader, type SiteData, type SocialLink, type SocialLinkIcon, type UserConfig, addLeadingSlash, addTrailingSlash, cleanUrl, inBrowser, isDataUrl, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };
+export { APPEARANCE_KEY, type AdditionalPage, type BaseRuntimePageInfo, type Config, DEFAULT_HIGHLIGHT_LANGUAGES, type Config$1 as DefaultThemeConfig, type DocFooter, type EditLink, type Feature, type FilterConfig, type Footer, type FrontMatterMeta, HASH_REGEXP, type Header, type Hero, type Image, type LocalSearchOptions, type Locale, type LocaleConfig, type LocaleLink, type LocaleLinks, MDX_REGEXP, type MarkdownOptions, type MdxRsOptions, type Nav, type NavItem, type NavItemWithChildren, type NavItemWithLink, type NavItemWithLinkAndChildren, type NormalizedConfig, type NormalizedConfig as NormalizedDefaultThemeConfig, type NormalizedLocales, type NormalizedSidebar, type NormalizedSidebarGroup, type PageData, type PageIndexInfo, type PageModule, type PageType, type RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, type RemotePageInfo, type RemoteSearchIndexInfo, type RemoteSearchOptions, type ReplaceRule, type Route, type RouteMeta, type RouteOptions, type RspressPlugin, SEARCH_INDEX_NAME, type SSGConfig, type SearchHooks, type SearchOptions, type Sidebar, type SidebarDivider, type SidebarGroup, type SidebarItem, type SidebarSectionHeader, type SiteData, type SocialLink, type SocialLinkIcon, type UserConfig, addLeadingSlash, addTrailingSlash, cleanUrl, inBrowser, isDataUrl, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeHash, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };

package/dist/index.js

@@ -1128,7 +1128,13 @@ var DEFAULT_HIGHLIGHT_LANGUAGES = [
 ];
 var isSCM = () => Boolean(process.env.BUILD_VERSION);
 var isProduction = () => process.env.NODE_ENV === "production";
-var isDebugMode = () => Boolean(process.env.DOC_DEBUG);
+var isDebugMode = () => {
+  if (!process.env.DEBUG) {
+    return false;
+  }
+  const values = process.env.DEBUG?.toLocaleLowerCase().split(",") ?? [];
+  return ["rsbuild", "builder", "*"].some((key) => values.includes(key));
+};
 var cleanUrl = (url) => url.replace(HASH_REGEXP, "").replace(QUERY_REGEXP, "");
 function slash(str) {
   return str.replace(/\\/g, "/");

package/dist/index.mjs

@@ -1070,7 +1070,13 @@ var DEFAULT_HIGHLIGHT_LANGUAGES = [
 ];
 var isSCM = () => Boolean(process.env.BUILD_VERSION);
 var isProduction = () => process.env.NODE_ENV === "production";
-var isDebugMode = () => Boolean(process.env.DOC_DEBUG);
+var isDebugMode = () => {
+  if (!process.env.DEBUG) {
+    return false;
+  }
+  const values = process.env.DEBUG?.toLocaleLowerCase().split(",") ?? [];
+  return ["rsbuild", "builder", "*"].some((key) => values.includes(key));
+};
 var cleanUrl = (url) => url.replace(HASH_REGEXP, "").replace(QUERY_REGEXP, "");
 function slash(str) {
   return str.replace(/\\/g, "/");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "0.0.0-next-20240620083724",
+  "version": "0.0.0-next-20241029080927",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -42,8 +42,8 @@
     }
   },
   "dependencies": {
-    "@rsbuild/core": "0.7.8",
-    "chalk": "4.1.2",
+    "@rsbuild/core": "~1.0.18",
+    "chalk": "5.3.0",
     "execa": "5.1.1",
     "fs-extra": "11.2.0",
     "gray-matter": "4.0.3",
@@ -51,18 +51,18 @@
   },
   "devDependencies": {
     "@types/fs-extra": "11.0.4",
-    "@types/interpret": "^1.1.1",
-    "@types/jest": "~29.5.12",
-    "@types/lodash": "^4.17.0",
-    "@types/lodash-es": "^4.17.8",
+    "@types/interpret": "^1.1.3",
+    "@types/jest": "~29.5.14",
+    "@types/lodash": "^4.17.12",
+    "@types/lodash-es": "^4.17.12",
     "@types/node": "^18.11.17",
-    "@types/react": "^18",
-    "@types/rechoir": "^0.6.1",
+    "@types/react": "^18.3.12",
+    "@types/rechoir": "^0.6.4",
     "lodash-es": "^4.17.21",
     "medium-zoom": "1.1.0",
     "rimraf": "^3.0.2",
-    "ts-node": "^10.9.1",
-    "typescript": "^5"
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.3"
   },
   "sideEffects": [],
   "publishConfig": {