@rspress/shared 0.0.0-next-20230815050107

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rspress
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# @rspress/shared

package/dist/index.d.ts

@@ -0,0 +1,576 @@
+import { BuilderConfig } from '@modern-js/builder-rspack-provider';
+import { PluggableList } from 'unified';
+import { BuilderPlugin } from '@modern-js/builder';
+
+interface Config$1 {
+    /**
+     * Whether to enable dark mode.
+     * @default true
+     */
+    darkMode?: boolean;
+    /**
+     * Custom outline title in the aside component.
+     *
+     * @default 'On this page'
+     */
+    outlineTitle?: string;
+    /**
+     * Whether to show the sidebar in right position.
+     */
+    outline?: boolean;
+    /**
+     * The nav items.
+     */
+    nav?: NavItem[];
+    /**
+     * The sidebar items.
+     */
+    sidebar?: Sidebar;
+    /**
+     * Info for the edit link. If it's undefined, the edit link feature will
+     * be disabled.
+     */
+    editLink?: EditLink;
+    /**
+     * Set custom last updated text.
+     *
+     * @default 'Last updated'
+     */
+    lastUpdatedText?: string;
+    /**
+     * Set custom last updated text.
+     *
+     * @default false
+     */
+    lastUpdated?: boolean;
+    /**
+     * Set custom prev/next labels.
+     */
+    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.
+     */
+    socialLinks?: SocialLink[];
+    /**
+     * The footer configuration.
+     */
+    footer?: Footer;
+    /**
+     * The prev page text.
+     */
+    prevPageText?: string;
+    /**
+     * The next page text.
+     */
+    nextPageText?: string;
+    /**
+     * Locale config
+     */
+    locales?: LocaleConfig[];
+    /**
+     * Whether to open the full text search
+     */
+    search?: boolean;
+    /**
+     * Whether to use back top
+     */
+    backTop?: boolean;
+    /**
+     * Whether to hide the navbar
+     */
+    hideNavbar?: boolean;
+}
+/**
+ * locale config
+ */
+interface LocaleConfig {
+    /**
+     * Site i18n config, which will recover the locales config in the site level.
+     */
+    lang: string;
+    title?: string;
+    description?: string;
+    label: string;
+    /**
+     * Theme i18n config
+     */
+    nav?: NavItem[];
+    sidebar?: Sidebar;
+    outlineTitle?: string;
+    lastUpdatedText?: string;
+    lastUpdated?: boolean;
+    editLink?: EditLink;
+    prevPageText?: string;
+    nextPageText?: string;
+    langRoutePrefix?: string;
+}
+type NavItem = NavItemWithLink | NavItemWithChildren;
+type NavItemWithLink = {
+    text: string;
+    link: string;
+    tag?: string;
+    activeMatch?: string;
+    position?: 'left' | 'right';
+};
+interface NavItemWithChildren {
+    text?: string;
+    tag?: string;
+    items: (NavItemWithChildren | NavItemWithLink)[];
+    position?: 'left' | 'right';
+}
+type Image = string | {
+    src: string;
+    alt?: string;
+};
+interface Sidebar {
+    [path: string]: (SidebarGroup | SidebarItem)[];
+}
+interface SidebarGroup {
+    text: string;
+    link?: string;
+    tag?: string;
+    items: (SidebarItem | SidebarGroup | string)[];
+    collapsible?: boolean;
+    collapsed?: boolean;
+}
+type SidebarItem = {
+    text: string;
+    link: string;
+    tag?: string;
+};
+interface EditLink {
+    /**
+     * Custom repository url for edit link.
+     */
+    docRepoBaseUrl: string;
+    /**
+     * Custom text for edit link.
+     *
+     * @default 'Edit this page'
+     */
+    text?: string;
+}
+interface DocFooter {
+    /**
+     * Custom label for previous page button.
+     */
+    prev?: SidebarItem;
+    /**
+     * Custom label for next page button.
+     */
+    next?: SidebarItem;
+}
+interface SocialLink {
+    icon: SocialLinkIcon;
+    mode: 'link' | 'text' | 'img';
+    content: string;
+}
+type SocialLinkIcon = 'lark' | 'discord' | 'facebook' | 'github' | 'instagram' | 'linkedin' | 'slack' | 'twitter' | 'youtube' | 'weixin' | 'qq' | 'juejin' | 'zhihu' | 'bilibili' | 'weibo' | 'gitlab' | {
+    svg: string;
+};
+interface Footer {
+    message?: string;
+}
+interface LocaleLinks {
+    text: string;
+    items: LocaleLink[];
+}
+interface LocaleLink {
+    text: string;
+    link: string;
+}
+interface NormalizedSidebarGroup extends Omit<SidebarGroup, 'items'> {
+    items: (SidebarItem | NormalizedSidebarGroup)[];
+    collapsible: boolean;
+    collapsed: boolean;
+}
+interface NormalizedSidebar {
+    [path: string]: (NormalizedSidebarGroup | SidebarItem)[];
+}
+interface NormalizedLocales extends Omit<LocaleConfig, 'sidebar'> {
+    sidebar: NormalizedSidebar;
+}
+interface NormalizedConfig extends Omit<Config$1, 'locales' | 'sidebar'> {
+    locales: NormalizedLocales[];
+    sidebar: NormalizedSidebar;
+}
+
+/**
+ * There are two ways to define what addtion routes represent.
+ * 1. Define filepath, then the content will be read from the file.
+ * 2. Define content, then then content will be written to temp file and read from it.
+ */
+interface AdditionalPage {
+    routePath: string;
+    content?: string;
+    filepath?: string;
+}
+interface RspressPlugin {
+    /**
+     * Name of the plugin.
+     */
+    name: string;
+    /**
+     * Global style
+     */
+    globalStyles?: string;
+    /**
+     * Markdown options.
+     */
+    markdown?: {
+        remarkPlugins?: PluggableList;
+        rehypePlugins?: PluggableList;
+        globalComponents?: string[];
+    };
+    /**
+     * Builder config.
+     */
+    builderConfig?: BuilderConfig;
+    /**
+     * Inject global components.
+     */
+    globalUIComponents?: string[];
+    /**
+     * Modify doc config.
+     */
+    config?: (config: UserConfig) => UserConfig | Promise<UserConfig>;
+    /**
+     * Callback before build
+     */
+    beforeBuild?: (config: UserConfig, isProd: boolean) => Promise<void>;
+    /**
+     * Callback after build
+     */
+    afterBuild?: (config: UserConfig, isProd: boolean) => Promise<void>;
+    /**
+     * Extend every page's data
+     */
+    extendPageData?: (pageData: PageIndexInfo & {
+        [key: string]: unknown;
+    }) => void | Promise<void>;
+    /**
+     * Add custom route
+     */
+    addPages?: (config: UserConfig, isProd: boolean) => AdditionalPage[] | Promise<AdditionalPage[]>;
+    /**
+     * Callback after route generated
+     */
+    routeGenerated?: (routes: RouteMeta[]) => Promise<void> | void;
+    /**
+     * Add addition ssg routes, for dynamic routes.
+     */
+    addSSGRoutes?: (config: UserConfig, isProd: boolean) => {
+        path: string;
+    }[] | Promise<{
+        path: string;
+    }[]>;
+    /**
+     * @private
+     * Modify search index data.
+     */
+    modifySearchIndexData?: (data: PageIndexInfo[]) => void | Promise<void>;
+}
+
+interface Route {
+    path: string;
+    element: React.ReactElement;
+    filePath: string;
+    preload: () => Promise<PageModule<React.ComponentType<unknown>>>;
+    lang: string;
+}
+interface RouteMeta {
+    routePath: string;
+    absolutePath: string;
+    relativePath: string;
+    pageName: string;
+    lang: string;
+}
+interface ReplaceRule {
+    search: string | RegExp;
+    replace: string;
+}
+interface Header {
+    id: string;
+    text: string;
+    depth: number;
+    charIndex: number;
+}
+interface Locale {
+    lang: string;
+    label: string;
+    title?: string;
+    description?: string;
+}
+interface UserConfig<ThemeConfig = Config$1> {
+    /**
+     * The root directory of the site.
+     */
+    root?: string;
+    /**
+     * Path to the logo file in nav bar.
+     */
+    logo?: string | {
+        dark: string;
+        light: string;
+    };
+    /**
+     * Base path of the site.
+     */
+    base?: string;
+    /**
+     * Path to html icon file.
+     */
+    icon?: string;
+    /**
+     * Language of the site.
+     */
+    lang?: string;
+    /**
+     * Title of the site.
+     */
+    title?: string;
+    /**
+     * Description of the site.
+     */
+    description?: string;
+    /**
+     * Head tags.
+     */
+    head?: string[];
+    /**
+     * I18n config of the site.
+     */
+    locales?: Locale[];
+    /**
+     * The i18n text data source path. Default is `i18n.json` in cwd.
+     */
+    i18nSourcePath?: string;
+    /**
+     * Theme config.
+     */
+    themeConfig?: ThemeConfig;
+    /**
+     * Builder Configuration
+     */
+    builderConfig?: BuilderConfig;
+    /**
+     * The custom config of vite-plugin-route
+     */
+    route?: RouteOptions;
+    /**
+     * The custom config of markdown compile
+     */
+    markdown?: MarkdownOptions;
+    /**
+     * Doc plugins
+     */
+    plugins?: RspressPlugin[];
+    /**
+     * Replace rule, will replace the content of the page.
+     */
+    replaceRules?: ReplaceRule[];
+    /**
+     * Output directory
+     */
+    outDir?: string;
+    /**
+     * Custom theme directory
+     */
+    themeDir?: string;
+    /**
+     * Global components
+     */
+    globalUIComponents?: string[];
+    /**
+     * Global styles, is a Absolute path
+     */
+    globalStyles?: string;
+    /**
+     * Search options
+     */
+    search?: SearchOptions;
+    /**
+     * Whether to enable medium-zoom, default is true
+     */
+    mediumZoom?: boolean | {
+        selector?: string;
+    };
+    /**
+     * Add some extra builder plugins
+     */
+    builderPlugins?: BuilderPlugin[];
+}
+type BaseRuntimePageInfo = Omit<PageIndexInfo, 'id' | 'content' | 'domain'>;
+interface SiteData<ThemeConfig = NormalizedConfig> {
+    root: string;
+    base: string;
+    lang: string;
+    title: string;
+    description: string;
+    icon: string;
+    themeConfig: ThemeConfig;
+    logo: string | {
+        dark: string;
+        light: string;
+    };
+    pages: BaseRuntimePageInfo[];
+    search: SearchOptions;
+    markdown: {
+        showLineNumbers: boolean;
+    };
+}
+type PageIndexInfo = {
+    id: number;
+    title: string;
+    routePath: string;
+    toc: Header[];
+    content: string;
+    frontmatter: Record<string, unknown>;
+    lang: string;
+    domain: string;
+    _filepath: string;
+    _relativePath: string;
+};
+type RemotePageInfo = PageIndexInfo & {
+    _matchesPosition: {
+        content: {
+            start: number;
+            length: number;
+        }[];
+    };
+};
+interface Hero {
+    name: string;
+    text: string;
+    tagline: string;
+    image?: {
+        src: string;
+        alt: string;
+    };
+    actions: {
+        text: string;
+        link: string;
+        theme: 'brand' | 'alt';
+    }[];
+}
+interface Feature {
+    icon: string;
+    title: string;
+    details: string;
+    link?: string;
+}
+interface PageModule<T extends React.ComponentType<unknown>> {
+    default: T;
+    frontmatter?: FrontMatterMeta;
+    content?: string;
+    [key: string]: unknown;
+}
+type PageType = 'home' | 'doc' | 'custom' | '404' | 'blank';
+interface FrontMatterMeta {
+    title?: string;
+    description?: string;
+    overview?: boolean;
+    pageType?: PageType;
+    features?: Feature[];
+    hero?: Hero;
+    sidebar?: boolean;
+    outline?: boolean;
+    lineNumbers?: boolean;
+}
+interface PageData {
+    siteData: SiteData<Config$1>;
+    page: BaseRuntimePageInfo & {
+        pagePath: string;
+        lastUpdatedTime?: string;
+        description?: string;
+        pageType: PageType;
+        _relativePath: string;
+    };
+}
+interface RouteOptions {
+    /**
+     * The directory to search for pages
+     */
+    root?: string;
+    /**
+     * The basename of the site
+     */
+    prefix?: string;
+    /**
+     * The extension name of the filepath that will be converted to a route
+     * @default ['js','jsx','ts','tsx','md','mdx']
+     */
+    extensions?: string[];
+    /**
+     * Include extra files from being converted to routes
+     */
+    include?: string[];
+    /**
+     * Exclude files from being converted to routes
+     */
+    exclude?: string[];
+}
+interface SearchHooks {
+    /**
+     * The search hook function path. The corresponding file should export a function named `onSearch`.
+     */
+    searchHooks?: string;
+}
+type LocalSearchOptions = SearchHooks & {
+    mode: 'local';
+};
+type RemoteSearchIndexInfo = string | {
+    value: string;
+    label: string;
+};
+type RemoteSearchOptions = SearchHooks & {
+    mode: 'remote';
+    apiUrl: string;
+    domain?: string;
+    indexName: string;
+    searchIndexes?: RemoteSearchIndexInfo[];
+};
+type SearchOptions = LocalSearchOptions | RemoteSearchOptions | false;
+interface MarkdownOptions {
+    remarkPlugins?: PluggableList;
+    rehypePlugins?: PluggableList;
+    checkDeadLinks?: boolean;
+    experimentalMdxRs?: boolean;
+    showLineNumbers?: boolean;
+    globalComponents?: string[];
+}
+type Config = UserConfig | Promise<UserConfig> | ((env: any) => UserConfig | Promise<UserConfig>);
+
+declare const QUERY_REGEXP: RegExp;
+declare const HASH_REGEXP: RegExp;
+declare const MDX_REGEXP: RegExp;
+declare const APPEARANCE_KEY = "modern-theme-appearance";
+declare const SEARCH_INDEX_NAME = "search_index";
+declare const isSCM: () => boolean;
+declare const isProduction: () => boolean;
+declare const isDebugMode: () => boolean;
+declare const cleanUrl: (url: string) => string;
+declare const inBrowser: () => boolean;
+declare function addLeadingSlash(url: string): string;
+declare function removeLeadingSlash(url: string): string;
+declare function removeTrailingSlash(url: string): string;
+declare function normalizeSlash(url: string): string;
+declare function isExternalUrl(url: string): boolean;
+declare function replaceLang(rawUrl: string, targetLang: string, defaultLang: string, langs: string[], base?: string): string;
+declare const omit: (obj: Record<string, unknown>, keys: string[]) => {
+    [x: string]: unknown;
+};
+declare const parseUrl: (url: string) => {
+    url: string;
+    hash: string;
+};
+declare function normalizeHref(url?: string): string;
+declare function withoutLang(path: string, langs: string[]): string;
+declare function withoutBase(path: string, base?: string): string;
+declare function withBase(url?: string, base?: string): string;
+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, NormalizedConfig, NormalizedConfig as NormalizedDefaultThemeConfig, NormalizedLocales, NormalizedSidebar, NormalizedSidebarGroup, PageData, PageIndexInfo, PageModule, PageType, QUERY_REGEXP, 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, normalizeSlash, omit, parseUrl, removeBase, removeLeadingSlash, removeTrailingSlash, replaceLang, withBase, withoutBase, withoutHash, withoutLang };