@rspress/shared 0.0.9 → 0.0.11

package/dist/index.d.ts

@@ -2,6 +2,52 @@ import { BuilderConfig } from '@modern-js/builder-rspack-provider';
 import { PluggableList } from 'unified';
 import { BuilderPlugin } from '@modern-js/builder';
 
+interface ZoomOptions {
+  /**
+   * The space outside the zoomed image.
+   *
+   * @default 0
+   */
+  margin?: number
+
+  /**
+   * The background of the overlay.
+   *
+   * @default '#fff'
+   */
+  background?: string
+
+  /**
+   * The number of pixels to scroll to close the zoom.
+   *
+   * @default 40
+   */
+  scrollOffset?: number
+
+  /**
+   * The viewport to render the zoom in.
+   *
+   * @default null
+   */
+  container?: string | HTMLElement | ZoomContainer
+
+  /**
+   * The template element to display on zoom.
+   *
+   * @default null
+   */
+  template?: string | HTMLTemplateElement
+}
+
+interface ZoomContainer {
+  width?: number
+  height?: number
+  top?: number
+  bottom?: number
+  right?: number
+  left?: number
+}
+
 interface Config$1 {
     /**
      * Whether to enable dark mode.
@@ -105,7 +151,7 @@ interface LocaleConfig {
     nextPageText?: string;
     langRoutePrefix?: string;
 }
-type NavItem = NavItemWithLink | NavItemWithChildren;
+type NavItem = NavItemWithLink | NavItemWithChildren | NavItemWithLinkAndChildren;
 type NavItemWithLink = {
     text: string;
     link: string;
@@ -116,7 +162,15 @@ type NavItemWithLink = {
 interface NavItemWithChildren {
     text?: string;
     tag?: string;
-    items: (NavItemWithChildren | NavItemWithLink)[];
+    items: NavItem[];
+    position?: 'left' | 'right';
+}
+interface NavItemWithLinkAndChildren {
+    text: string;
+    link: string;
+    items: NavItem[];
+    tag?: string;
+    activeMatch?: string;
     position?: 'left' | 'right';
 }
 type Image = string | {
@@ -230,7 +284,7 @@ interface RspressPlugin {
     /**
      * Inject global components.
      */
-    globalUIComponents?: string[];
+    globalUIComponents?: (string | [string, object])[];
     /**
      * Modify doc config.
      */
@@ -381,7 +435,7 @@ interface UserConfig<ThemeConfig = Config$1> {
     /**
      * Global components
      */
-    globalUIComponents?: string[];
+    globalUIComponents?: (string | [string, object])[];
     /**
      * Global styles, is a Absolute path
      */
@@ -395,6 +449,7 @@ interface UserConfig<ThemeConfig = Config$1> {
      */
     mediumZoom?: boolean | {
         selector?: string;
+        options?: ZoomOptions;
     };
     /**
      * Add some extra builder plugins
@@ -577,4 +632,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, 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, slash, withBase, withoutBase, withoutHash, withoutLang };

package/dist/logger.d.ts

@@ -0,0 +1,12 @@
+declare const rspressMark: string;
+interface Logger {
+    info: (msg: string) => void;
+    error: (msg: string) => void;
+    warn: (msg: string) => void;
+    success: (msg: string) => void;
+    debug: (msg: string) => void;
+    log: (msg: string) => void;
+}
+declare const logger: Logger;
+
+export { Logger, logger, rspressMark };

package/dist/logger.js

@@ -0,0 +1,64 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/logger.ts
+var logger_exports = {};
+__export(logger_exports, {
+  logger: () => logger,
+  rspressMark: () => rspressMark
+});
+module.exports = __toCommonJS(logger_exports);
+var import_chalk = __toESM(require("chalk"));
+var rspressMark = import_chalk.default.cyan("[Rspress]");
+var logger = {
+  info(msg) {
+    console.log(`${import_chalk.default.cyan.bold("[info]")} ${msg}`);
+  },
+  error(msg) {
+    console.log(`${import_chalk.default.red("[error]")} ${msg}`);
+  },
+  warn(msg) {
+    console.log(`${import_chalk.default.yellow("[warn]")} ${msg}`);
+  },
+  success(msg) {
+    console.log(`${import_chalk.default.green("[success]")} ${msg}`);
+  },
+  debug(msg) {
+    if (process.env.DEBUG) {
+      console.log(`${import_chalk.default.gray("[rspress:debug]")} ${msg}`);
+    }
+  },
+  log(msg) {
+    console.log(`${import_chalk.default.cyan("[rspress]")} ${msg}`);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  logger,
+  rspressMark
+});

package/dist/logger.mjs

@@ -0,0 +1,29 @@
+// src/logger.ts
+import chalk from "chalk";
+var rspressMark = chalk.cyan("[Rspress]");
+var logger = {
+  info(msg) {
+    console.log(`${chalk.cyan.bold("[info]")} ${msg}`);
+  },
+  error(msg) {
+    console.log(`${chalk.red("[error]")} ${msg}`);
+  },
+  warn(msg) {
+    console.log(`${chalk.yellow("[warn]")} ${msg}`);
+  },
+  success(msg) {
+    console.log(`${chalk.green("[success]")} ${msg}`);
+  },
+  debug(msg) {
+    if (process.env.DEBUG) {
+      console.log(`${chalk.gray("[rspress:debug]")} ${msg}`);
+    }
+  },
+  log(msg) {
+    console.log(`${chalk.cyan("[rspress]")} ${msg}`);
+  }
+};
+export {
+  logger,
+  rspressMark
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/shared",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -9,10 +9,23 @@
     "url": "https://github.com/web-infra-dev/rspress",
     "directory": "packages/shared"
   },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./logger": {
+      "import": "./dist/logger.mjs",
+      "require": "./dist/logger.js",
+      "types": "./dist/logger.d.ts"
+    }
+  },
   "dependencies": {
-    "@modern-js/builder": "2.33.0",
-    "@modern-js/builder-rspack-provider": "2.33.0",
-    "unified": "10.1.2"
+    "@modern-js/builder": "2.34.0",
+    "@modern-js/builder-rspack-provider": "2.34.0",
+    "unified": "10.1.2",
+    "chalk": "4.1.2"
   },
   "devDependencies": {
     "lodash-es": "^4.17.21",
@@ -25,7 +38,8 @@
     "@types/rechoir": "^0.6.1",
     "rimraf": "~3.0.2",
     "ts-node": "^10.9.1",
-    "typescript": "~5.0.4"
+    "typescript": "~5.0.4",
+    "medium-zoom": "1.0.8"
   },
   "sideEffects": [],
   "publishConfig": {