@rspress/shared 0.0.0-nightly-20231018160139 → 0.0.0-nightly-20231020160328

package/dist/index.d.ts

@@ -291,29 +291,33 @@ interface RspressPlugin {
     config?: (config: UserConfig, utils: {
         addPlugin: (plugin: RspressPlugin) => void;
         removePlugin: (pluginName: string) => void;
-    }) => UserConfig | Promise<UserConfig>;
+    }, isProd: boolean) => UserConfig | Promise<UserConfig>;
     /**
      * Callback before build
      */
-    beforeBuild?: (config: UserConfig, isProd: boolean) => Promise<void>;
+    beforeBuild?: (config: UserConfig, isProd: boolean) => void | Promise<void>;
     /**
      * Callback after build
      */
-    afterBuild?: (config: UserConfig, isProd: boolean) => Promise<void>;
+    afterBuild?: (config: UserConfig, isProd: boolean) => void | Promise<void>;
     /**
      * Extend every page's data
      */
     extendPageData?: (pageData: PageIndexInfo & {
         [key: string]: unknown;
-    }) => void | Promise<void>;
+    }, isProd: boolean) => void | Promise<void>;
     /**
      * Add custom route
      */
     addPages?: (config: UserConfig, isProd: boolean) => AdditionalPage[] | Promise<AdditionalPage[]>;
+    /**
+     * Add runtime modules
+     */
+    addRuntimeModules?: (config: UserConfig, isProd: boolean) => Record<string, string> | Promise<Record<string, string>>;
     /**
      * Callback after route generated
      */
-    routeGenerated?: (routes: RouteMeta[]) => Promise<void> | void;
+    routeGenerated?: (routes: RouteMeta[], isProd: boolean) => Promise<void> | void;
     /**
      * Add addition ssg routes, for dynamic routes.
      */
@@ -326,7 +330,7 @@ interface RspressPlugin {
      * @private
      * Modify search index data.
      */
-    modifySearchIndexData?: (data: PageIndexInfo[]) => void | Promise<void>;
+    modifySearchIndexData?: (data: PageIndexInfo[], isProd: boolean) => void | Promise<void>;
 }
 
 interface Route {
@@ -664,6 +668,11 @@ declare function replaceLang(rawUrl: string, lang: {
     current: string;
     default: string;
 }, base?: string): string;
+declare function replaceVersion(rawUrl: string, version: {
+    current: string;
+    target: string;
+    default: string;
+}, base?: string): string;
 declare const omit: (obj: Record<string, unknown>, keys: string[]) => {
     [x: string]: unknown;
 };
@@ -679,4 +688,4 @@ declare function removeBase(url: string, base: string): string;
 declare function withoutHash(url: string): string;
 declare const mergeDocConfig: (...configs: UserConfig[]) => UserConfig;
 
-export { APPEARANCE_KEY, AdditionalPage, BaseRuntimePageInfo, Config, Config$1 as DefaultThemeConfig, DocFooter, EditLink, Feature, Footer, FrontMatterMeta, HASH_REGEXP, Header, Hero, Image, LocalSearchOptions, Locale, LocaleConfig, LocaleLink, LocaleLinks, MDX_REGEXP, MarkdownOptions, NavItem, NavItemWithChildren, NavItemWithLink, NavItemWithLinkAndChildren, NormalizedConfig, NormalizedConfig as NormalizedDefaultThemeConfig, NormalizedLocales, NormalizedSidebar, NormalizedSidebarGroup, PageData, PageIndexInfo, PageModule, PageType, RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, RemotePageInfo, RemoteSearchIndexInfo, RemoteSearchOptions, ReplaceRule, Route, RouteMeta, RouteOptions, RspressPlugin, SEARCH_INDEX_NAME, SearchHooks, SearchOptions, Sidebar, SidebarGroup, SidebarItem, SiteData, SocialLink, SocialLinkIcon, UserConfig, addLeadingSlash, cleanUrl, inBrowser, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeLeadingSlash, removeTrailingSlash, replaceLang, slash, withBase, withoutBase, withoutHash, withoutLang };
+export { APPEARANCE_KEY, AdditionalPage, BaseRuntimePageInfo, Config, Config$1 as DefaultThemeConfig, DocFooter, EditLink, Feature, Footer, FrontMatterMeta, HASH_REGEXP, Header, Hero, Image, LocalSearchOptions, Locale, LocaleConfig, LocaleLink, LocaleLinks, MDX_REGEXP, MarkdownOptions, NavItem, NavItemWithChildren, NavItemWithLink, NavItemWithLinkAndChildren, NormalizedConfig, NormalizedConfig as NormalizedDefaultThemeConfig, NormalizedLocales, NormalizedSidebar, NormalizedSidebarGroup, PageData, PageIndexInfo, PageModule, PageType, RspressPlugin as Plugin, QUERY_REGEXP, RSPRESS_TEMP_DIR, RemotePageInfo, RemoteSearchIndexInfo, RemoteSearchOptions, ReplaceRule, Route, RouteMeta, RouteOptions, RspressPlugin, SEARCH_INDEX_NAME, SearchHooks, SearchOptions, Sidebar, SidebarGroup, SidebarItem, SiteData, SocialLink, SocialLinkIcon, UserConfig, addLeadingSlash, cleanUrl, inBrowser, isDebugMode, isExternalUrl, isProduction, isSCM, mergeDocConfig, normalizeHref, normalizePosixPath, normalizeSlash, omit, parseUrl, removeBase, removeLeadingSlash, removeTrailingSlash, replaceLang, replaceVersion, slash, withBase, withoutBase, withoutHash, withoutLang };