@maple-design/cli-vue 0.0.0-stage → 1.1.0

package/README.md

@@ -1,3 +1,306 @@
-# Temporary Holding Version
+# Components Library Tools
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+### Intro
+
+`watchLang(callback)` detects both desktop documentation routes and mobile iframe query parameters, including the initial language and subsequent changes. An explicit `pc` or `mobile` argument remains available when needed.
+
+The out-of-the-box `Vue3 component library` rapid prototyping tool provides a series of commands and tools to solve the problem of component library development.
+
+### Features
+
+- 📦  Out-of-the-box component library development environment
+- 📦  An out-of-the-box component library compilation tool that supports exporting `esm`, `cjs`, `umd` module codes
+- 🛠️  Configuration file-based component library documentation site, support Baidu statistics and theme customization
+- 🛠️  Supports both `sfc` and `tsx` styles for writing component libraries
+- 📦  Out-of-the-box code inspection tool
+- 📦  Out-of-the-box unit testing tools
+- 📦  Out-of-the-box code publishing tool, publishes to both `npm` and `github`, and automatically generates changelogs
+- 💪  Support for `VSCode` extension development
+- 💪  Support `build svg to web fonts`
+- 💪  Support for `Typescript`
+- 💪  Support `Various themes, including default / maple brands and light / dark modes`
+- 🌍  Support `Internationalization`
+- 🚀  Based on `pnpm`
+
+### Quickstart
+
+`@maple-design/cli-vue` has built-in `sfc` and `tsx` style component library project templates, which can be generated directly by the `gen` command.
+It is convenient for you to directly enter the component library development.
+
+```shell
+# playground-ignore
+pnpm add @maple-design/cli-vue -g
+maple-cli gen
+```
+
+## Advanced customization
+
+### Configuration file
+
+The `maple.config.mjs` in the project root directory is used to manage the specific details of the entire component library project.
+The default configuration can be viewed [maple.default.config.ts](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.default.config.ts?ref_type=heads).
+Also refer to `@maple-design/ui-vue` [maple.config.mjs](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/ui/maple.config.mjs?ref_type=heads).
+
+| Parameter | Description | Type | Default |
+| --- | -------------- | -------- | ---------- |
+| `name` | The full name of the component library, which will be used as the package name | _string_ | `Maple` |
+| `namespace` | Component library namespace, will be used as component prefix | _string_ | `var` |
+| `host` | Development server host | _number_ | `localhost` |
+| `port` | Development server port | _number_ | `8080` |
+| `proxy` | Development server proxy | _Record<string, string \| ProxyOptions>_ | `-` |
+| `title` | The title of the component library in the document | _string_ | `Maple` |
+| `logo` | The logo of the component library in the document | _string_ | `-` |
+| `alias` | Path alias (root is src folder when use relative path) | _Record<string, string>_ | `-` |
+| `defaultLanguage` | Document default language | _string_ | `zh-CN` |
+| `defaultLightTheme` | Default light-mode selection | _string_ | `lightTheme` |
+| `defaultDarkTheme` | Default dark-mode selection | _string_ | `darkTheme` |
+| `useMobile` | Whether to display the mobile phone preview on the right | _boolean_ | `false` |
+| `themeKey` | The key of the theme in local storage | _string_ | `MAPLE_THEME` |
+| `lightTheme` | Default brand light document theme | _Record<string, any>_ | `-` |
+| `darkTheme` | Default brand dark document theme | _Record<string, any>_ | `-` |
+| `mapleLightTheme` | Maple brand light document theme | _Record<string, any>_ | `-` |
+| `mapleDarkTheme` | Maple brand dark document theme | _Record<string, any>_ | `-` |
+| `highlight` | Document code snippet style related | _{ style: string }_ | `-` |
+| `analysis` | Document statistics related | _{ baidu: string }_ | `-` |
+| `pc` | PC side document structure configuration | _[MapleConfigPc](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.config.ts?ref_type=heads)_ | `-` |
+| `mobile` | Mobile document structure configuration | _[MapleConfigMobile](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.config.ts?ref_type=heads)_ | `-` |
+| `bundle` | Bundle output options | _{ external: string[], globals: Record<string, string> }_ | `-` |
+| `vitePlugins` | vite plugins | _[Plugin](https://vite.dev/guide/using-plugins.html)[]_ \| `(plugins: Plugin[]) => Plugin[])` | `-` |
+| `directives` | Component library directive folder name | _string[]_ | `[]` |
+| `copy` | Copy file configuration | _[CopyPath[]](https://github.com/loca-spirit/maple-design-mobile/blob/main/packages/vite-plugins/src/copy.ts)_ | `- ` |
+| `icons` | Font icon packaging related configurations | _[MapleConfigIcons](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.config.ts?ref_type=heads) _ | `-` |
+| `esbuild` | esbuild configuration | _[MapleConfigEsbuild](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.config.ts?ref_type=heads)_ | ` -` |
+| `seo` | seo options | _[MapleConfigSeo](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.config.ts?ref_type=heads)_ | ` -` |
+
+#### Menu
+
+| Parameter | Description | Type | Default |
+| --- | -------------- | -------- | ---------- |
+| `doc` | The document page corresponds to the matching file name, required | _string_ | `-` |
+| `type` | The type of menu, when the type is `1`, it means the category menu, when the type is `2`, the doc field matches the component file under src, when the type is `3`, the doc field matches the md file under docs, required | _MenuTypes_ | `-` |
+| `text` | The text displayed in the menu, English display text can be configured when internationalization is set, required | _Record<string, string>_ | `-` |
+| `useMobile` | Whether to display the mobile phone preview on the right side on the current document page, if not filled, the default value is useMobile in config  | _boolean_ | `-` |
+
+### Custom pages
+
+If you want to insert other pages into the component library, you can create a `pages` folder in the project root directory to write a vue component to generate other pages.
+The directory structure is as follows:
+
+```text
+// playground-ignore
+|-- maple-ui
+  |-- src
+  |-- docs
+  |-- pages
+    |-- sponsor
+      |-- index.vue
+    |-- contributor
+      |-- locale
+        |-- en-US.ts
+      |-- index.vue
+    |-- changelog
+      |-- locale
+        |-- zh-CN.ts
+        |-- en-US.ts
+      |-- index.vue
+      
+```
+
+The resulting route is as follows:
+
+```text
+// playground-ignore
+/zh-CN/sponsor
+/en-US/contributor
+/zh-CN/changelog
+/en-US/changelog
+```
+
+### Command related
+
+#### Start the development server
+
+```shell
+# playground-ignore
+maple-cli dev
+# force mode
+maple-cli dev -f
+# draft mode
+maple-cli dev -d
+```
+
+#### Build a documentation site
+
+Documentation development resolves components and styles from `src`. It generates `.maple` site pages/configuration without clearing or rewriting npm artifacts in `es` / `lib`, including configuration or research-menu restarts. Demo development does not require a library build first.
+
+Markdown supports standalone `<demo src="../example/demos/basic.vue"></demo>` tags (including self-closing tags) and `demo` fences. Each referenced Vue file renders in its own live card with a source toolbar. Tags inside code samples remain static. Editing a Vue demo updates both the rendered example and its source automatically. The mobile preview continues to render the collection in `example/index.vue`.
+
+Site component resolution follows the public export map directly to source modules, preventing circular barrel imports during documentation chunking. Authored function imports such as `import { Message } from '@maple-design/ui-vue'` retain automatic style injection. This is site-only resolution, not a change to published package entry points or a shared Cedar/Maple runtime.
+
+The standalone Playground still consumes a built component package: run `pnpm build:lib` at the repository root before `pnpm dev:play`. It reads the published entry/CSS and writes browser assets to its own `public` directory; it does not need documentation development stubs.
+
+Restart an already-running dev process once after upgrading the CLI to load the new behavior. The repository gate `pnpm check:dev-boundary` verifies artifact preservation on cold start and configuration/research restarts.
+
+```shell
+# playground-ignore
+maple-cli build
+```
+
+#### Preview documentation site
+
+```shell
+# playground-ignore
+maple-cli preview
+# set port number
+maple-cli preview -p <port>
+```
+
+#### Compile component library
+
+```shell
+# playground-ignore
+maple-cli compile
+```
+
+#### Compile style vars types declaration file
+
+```shell
+# playground-ignore
+maple-cli compile:style-vars
+```
+
+#### Run VSCode extension development environment
+
+```shell
+# playground-ignore
+maple-cli dev:extension
+```
+
+#### Build VSCode extension for production
+
+```shell
+# playground-ignore
+maple-cli build:extension
+```
+
+#### Build svg to web fonts
+
+```shell
+# playground-ignore
+maple-cli build:icons -w
+maple-cli build:icons
+```
+
+#### Execute all unit tests
+
+```shell
+# playground-ignore
+maple-cli test
+```
+
+#### Execute a unit test
+
+```shell
+# playground-ignore
+maple-cli test -c <componentName>
+```
+
+#### Execute unit tests in watch mode
+
+```shell
+# playground-ignore
+maple-cli test -w
+```
+
+#### Execute unit tests and report coverage
+
+```shell
+# playground-ignore
+maple-cli test -cov
+```
+
+#### Lint git commit message
+
+```shell
+# playground-ignore
+maple-cli commit-lint
+```
+
+#### Show checklist
+
+```shell
+# playground-ignore
+maple-cli checklist
+```
+
+#### Generate changelog
+
+```shell
+# playground-ignore
+maple-cli changelog
+```
+
+#### Release component library
+
+```shell
+# playground-ignore
+maple-cli release
+```
+
+#### Generate a project template
+
+```shell
+# playground-ignore
+maple-cli gen
+
+# Options
+-n
+--name
+  project name
+-s
+--sfc
+  Generate sfc-style project templates
+-t
+--tsx
+  Generate tsx-style project templates
+-l
+--locale
+  Need to support internationalization
+```
+
+#### Create a component template file
+
+```shell
+# playground-ignore
+maple-cli create
+
+# Options
+-n
+--name
+  project name
+-s
+--sfc
+  Generate sfc-style component
+-t
+--tsx
+  Generate tsx-style component
+-l
+--locale
+  Need to support internationalization
+```
+
+### Note before publish
+
+1. `npm` repository registry must set to `npm` official mirror
+2. Execute `npm login` to log in
+
+### Q & A
+
+#### How to solve failure of installing sharp ?
+
+- You can choose to change mirror site which contains binaries for both sharp and libvips.
+
+``` shell
+pnpm config set sharp_binary_host "https://npmmirror.com/mirrors/sharp"
+pnpm config set sharp_libvips_binary_host "https://npmmirror.com/mirrors/sharp-libvips"
+```

package/README.zh-CN.md

@@ -0,0 +1,305 @@
+# 组件库快速成型工具
+
+### 介绍
+
+开箱即用的 `Vue3组件库` 快速成型工具，提供了一系列命令和工具去解决组件库开发上的问题。
+
+### 特性
+
+- 📦  开箱即用的组件库开发环境
+- 📦  开箱即用的组件库编译工具，支持导出 `esm`, `cjs`, `umd` 三种模块代码
+- 🛠️  基于配置文件的组件库文档站点，支持百度统计和主题定制
+- 🛠️  支持 `sfc` 和 `tsx` 两种风格的组件库编写风格
+- 📦  开箱即用的代码检查工具
+- 📦  开箱即用的单元测试工具
+- 📦  开箱即用的代码发布工具,同时发布到 `npm` 和 `github`, 并自动生成更新日志
+- 💪  支持 `VSCode` 插件开发
+- 💪  支持 `字体图标打包`
+- 💪  支持 `Typescript`
+- 💪  支持 `多种主题, 包含 default / maple 品牌及明暗模式`
+- 🌍  支持 `国际化`
+- 🚀  基于 `pnpm`
+
+### 快速开始
+
+`@maple-design/cli-vue` 内置了 `sfc` 和 `tsx` 两种风格的组件库项目模板，可以通过 `gen` 命令直接生成。
+方便您直接进入组件库开发。
+
+```shell
+# playground-ignore
+pnpm add @maple-design/cli-vue -g
+maple-cli gen
+```
+
+## 高级定制
+
+### 配置文件
+
+项目根目录下的 `maple.config.mjs` 用来管理整个组件库项目的具体细节。
+默认配置可查阅 [maple.default.config.ts](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.default.config.ts?ref_type=heads)。
+也可以参考 `@maple-design/ui-vue` 的 [maple.config.mjs](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/ui/maple.config.mjs?ref_type=heads)。
+
+| 参数 | 说明 | 类型 | 默认值 |
+| -- | -------------- | -------- | ---------- |
+| `name` | 组件库全名，会作为包名 | _string_ | `Maple` |
+| `namespace` | 组件库命名空间, 会作为组件前缀 | _string_ | `var` |
+| `host` | 开发服务器主机 | _number_ | `localhost` |
+| `port` | 开发服务器端口 | _number_ | `8080` |
+| `proxy` | 开发服务器代理 | _Record<string, string \| ProxyOptions>_ | `-` |
+| `title` | 文档中组件库的标题 | _string_ | `Maple` |
+| `logo` | 文档中组件库的 logo | _string_ | `-` |
+| `alias` | 路径别名 (使用相对路径时，根路径为 src 文件夹) | _Record<string, string>_ | `-` |
+| `defaultLanguage` | 文档默认语言 | _string_ | `zh-CN` |
+| `defaultLightTheme` | 默认使用的亮色主题 | _string_ | `lightTheme` |
+| `defaultDarkTheme` | 默认使用的暗色主题 | _string_ | `darkTheme` |
+| `useMobile` | 是否显示右侧手机预览 | _boolean_ | `false` |
+| `themeKey` | 主题在本地存储中的 key | _string_ | `MAPLE_THEME` |
+| `lightTheme` | 默认品牌亮色文档主题 | _Record<string, any>_ | `-` |
+| `darkTheme` | 默认品牌暗色文档主题 | _Record<string, any>_ | `-` |
+| `mapleLightTheme` | 枫叶品牌亮色文档主题 | _Record<string, any>_ | `-` |
+| `mapleDarkTheme` | 枫叶品牌暗色文档主题 | _Record<string, any>_ | `-` |
+| `highlight` | 文档代码片段样式相关 | _{ style: string }_ | `-` |
+| `analysis` | 文档统计相关 | _{ baidu: string }_ | `-` |
+| `pc` | pc 端文档结构配置 | _[MapleConfigPc](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.config.ts?ref_type=heads)_ | `-` |
+| `mobile` | mobile 端文档结构配置 | _[MapleConfigMobile](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.config.ts?ref_type=heads)_ | `-` |
+| `bundle` | 组件库编译的捆绑产物配置 | _{ external: string[], globals: Record<string, string> }_ | `-` |
+| `vitePlugins` | vite 插件 | _[Plugin](https://vite.dev/guide/using-plugins.html)[]_ \| `(plugins: Plugin[]) => Plugin[])` | `-` |
+| `directives` | 组件库指令文件夹名称 | _string[]_ | `[]` |
+| `copy` | 复制文件配置 | _[CopyPath[]](https://github.com/loca-spirit/maple-design-mobile/blob/main/packages/vite-plugins/src/copy.ts)_ | `-` |
+| `icons` | 字体图标打包相关配置 | _[MapleConfigIcons](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.config.ts?ref_type=heads)_ | `-` |
+| `esbuild` | esbuild 配置 | _[MapleConfigEsbuild](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.config.ts?ref_type=heads)_ | `-` |
+| `seo` | seo 选项 | _[MapleConfigSeo](https://xxx/pe.frontend/materials/maplejs/maple-design-mobile/-/blob/master/packages/cli/src/node/config/maple.config.ts?ref_type=heads)_ | ` -` |
+
+#### Menu
+
+| 参数 | 说明 | 类型 | 默认值 |
+| -- | -------------- | -------- | ---------- |
+| `doc` | 文档页面应匹配的文件名称, 必填 | _string_ | `-` |
+| `type` | menu 类型, 当 type 为 `1` 时表示分类 menu, 类型为 `2` 时 doc 字段匹配 src 下的组件文件, 类型为`3`时 doc 字段匹配 docs 下的 md 文件 | _MenuTypes_ | `-` |
+| `text` | menu 所展示的文字, 当设置国际化时可配置英文展示文字 | _Record<string, string>_ | `-` |
+| `useMobile` | 是否在当前文档页显示右侧手机预览, 如不填写, 默认取 config 中的 useMobile | _boolean_ | `-` |
+
+### 自定义页面
+
+如果想在组件库中插入其他页面，可以在项目根目录下的创建 `pages` 文件夹编写 vue 组件， 用来生成其他的页面。
+目录结构如下：
+
+```text
+// playground-ignore
+|-- maple-ui
+  |-- src
+  |-- docs
+  |-- pages
+    |-- sponsor
+      |-- index.vue
+    |-- contributor
+      |-- locale
+        |-- en-US.ts
+      |-- index.vue
+    |-- changelog
+      |-- locale
+        |-- zh-CN.ts
+        |-- en-US.ts
+      |-- index.vue
+```
+
+生成的路由如下：
+
+```text
+// playground-ignore
+/zh-CN/sponsor
+/en-US/contributor
+/zh-CN/changelog
+/en-US/changelog
+```
+
+### 命令相关
+
+#### 启动开发服务器
+
+```shell
+# playground-ignore
+maple-cli dev
+# force mode
+maple-cli dev -f
+# draft mode
+maple-cli dev -d
+```
+
+#### 构建文档站点
+
+文档开发直接解析 `src` 中的组件和样式，只生成 `.maple` 站点配置与页面，不清空或改写 npm 发布用的 `es` / `lib`。修改配置或调研菜单触发重启时同样遵守此边界；不用先构建 npm 包才能展示 Demo。
+
+Markdown 支持独立一行的 `<demo src="../example/demos/basic.vue"></demo>`（也可自闭合）与 `demo` 代码围栏。两种写法都读取实际 Vue 文件，每个文件对应独立运行卡片和源码工具条；代码示例中的标签不会执行。修改 Vue 示例会自动更新运行内容与源码，无需手动同步静态副本。右侧手机预览继续读取 `example/index.vue` 的示例集合。
+
+Demo 的 `watchLang(callback)` 默认从当前站点路由读取语言：中间卡片使用 `#/en-US/component`，手机集合使用 `#/component?language=en-US`。初次挂载及顶部语言切换均同步，无需局部 locale 激活；必要时仍可显式指定 `pc` 或 `mobile`。
+
+文档站自动组件引用依据公开导出表直达源码模块，避免组件内部再经过全库根入口导致循环分包；显式函数导入仍可写 `import { Message } from '@maple-design/ui-vue'`，自动样式注入保留。该解析只作用于站点，不改变 npm 包入口或共享两库运行时。
+
+独立 Playground 仍需要已构建的组件包：先在仓库根执行 `pnpm build:lib`，再执行 `pnpm dev:play`。它读取发布入口与 CSS 并将浏览器资源写入自己的 `public`，不是文档 dev 的占位入口。
+
+升级 CLI 开发流程后，已经启动的旧 dev 进程需要手动重启一次才能使用新逻辑。仓库门禁 `pnpm check:dev-boundary` 验证冷启动和配置/调研重启不会破坏发布文件。
+
+```shell
+# playground-ignore
+maple-cli build
+```
+
+#### 预览文档站点
+
+```shell
+# playground-ignore
+maple-cli preview
+# set port number
+maple-cli preview -p <port>
+```
+
+#### 构建组件库
+
+```shell
+# playground-ignore
+maple-cli compile
+```
+
+#### 构建样式变量类型声明文件
+
+```shell
+# playground-ignore
+maple-cli compile:style-vars
+```
+
+#### 启动 VSCode 插件开发环境
+
+```shell
+# playground-ignore
+maple-cli dev:extension
+```
+
+#### 构建 VSCode 插件
+
+```shell
+# playground-ignore
+maple-cli build:extension
+```
+
+#### 打包字体图标
+
+```shell
+# playground-ignore
+maple-cli build:icons -w
+maple-cli build:icons
+```
+
+#### 执行所有的单元测试
+
+```shell
+# playground-ignore
+maple-cli test
+```
+
+#### 执行单个组件的单元测试
+
+```shell
+# playground-ignore
+maple-cli test -c <componentName>
+```
+
+#### 以 watch 模式执行单元测试
+
+```shell
+# playground-ignore
+maple-cli test -w
+```
+
+#### 执行所有的单元测试并报告覆盖率
+
+```shell
+# playground-ignore
+maple-cli test -cov
+```
+
+#### 校验提交信息
+
+```shell
+# playground-ignore
+maple-cli commit-lint
+```
+
+#### 显示检查清单
+
+```shell
+# playground-ignore
+maple-cli checklist
+```
+
+#### 生成更新日志
+
+```shell
+# playground-ignore
+maple-cli changelog
+```
+
+#### 发布组件库
+
+```shell
+# playground-ignore
+maple-cli release
+```
+
+#### 生成一个项目模板
+
+```shell
+# playground-ignore
+maple-cli gen
+
+# Options
+-n
+--name
+  项目名
+-s
+--sfc
+  生成 sfc 风格的项目模板
+-t
+--tsx
+  生成 tsx 格式项目
+-l
+--locale
+  需要支持国际化
+```
+
+#### 创建组件模板文件
+
+```shell
+# playground-ignore
+maple-cli create
+
+# Options
+-n
+--name
+  组件名
+-s
+--sfc
+  生成 sfc 风格的组件
+-t
+--tsx
+  生成 tsx 风格的文件
+-l
+--locale
+  需要支持国际化
+```
+
+### 发布前注意
+
+1. `npm` 的仓库源必须指向 `npm` 官方镜像
+2. 执行 `npm login` 进行登录
+
+### 问答
+
+#### 如何解决安装 sharp 失败的问题 ?
+
+- 您可以选择更改包含 sharp 和 libvips 二进制文件的镜像站点
+
+``` shell
+pnpm config set sharp_binary_host "https://npmmirror.com/mirrors/sharp"
+pnpm config set sharp_libvips_binary_host "https://npmmirror.com/mirrors/sharp-libvips"
+```

package/bin/cli.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+// This file must exist before the first workspace build so pnpm can link the
+// command during a clean install. Compilation still belongs to build:lib.
+await import('../lib/node/bin.js')

package/client.d.ts

@@ -0,0 +1 @@
+export * from './lib/client/index'

package/client.js

@@ -0,0 +1 @@
+export * from './lib/client/index.js'

package/lib/client/appType.d.ts

@@ -0,0 +1,4 @@
+declare const _default: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;

package/lib/client/appType.js

@@ -0,0 +1,7 @@
+import { defineComponent, h } from 'vue';
+export default defineComponent({
+    name: 'AppType',
+    setup(props, { slots }) {
+        return () => h('div', { class: 'app-type' }, [slots.default?.()]);
+    },
+});

package/lib/client/index.d.ts

@@ -0,0 +1,29 @@
+import { ThemeProvider } from '@maple-design/ui-vue';
+import AppType from './appType';
+interface PCLocationInfo {
+    language: string;
+    menuName: string;
+    hash: string;
+}
+export type Theme = 'lightTheme' | 'darkTheme' | 'mapleLightTheme' | 'mapleDarkTheme' | 'alpsLightTheme' | 'fireflyLightTheme' | 'alpsDarkTheme' | 'fireflyDarkTheme';
+export type ThemeScope = 'site' | 'demo';
+export type StyleVars = Record<string, string>;
+export declare function getPCLocationInfo(): PCLocationInfo;
+/** Site docs chrome theme (`themeKey`) vs mobile demo theme (`demoThemeKey`). */
+export declare function getBrowserTheme(scope?: ThemeScope): Theme;
+export declare function persistTheme(theme: Theme, scope?: ThemeScope): void;
+export declare function watchLang(cb: (lang: string) => void, platform?: 'pc' | 'mobile'): void;
+export declare function withSiteConfigNamespace(styleVars: Record<string, any>): StyleVars;
+export declare function watchPlatform(cb: (platform: string) => void): void;
+export declare function useRouteListener(cb: () => void): void;
+export declare const currentThemePreset: import("vue").ShallowRef<StyleVars, StyleVars>;
+export declare const currentStyleVars: import("vue").ShallowRef<Record<string, string>, Record<string, string>>;
+export { currentTheme } from './theme-state';
+export declare function setTheme(theme: Theme): void;
+export declare function onThemeChange(cb?: (theme: Theme) => void, scope?: ThemeScope): void;
+export declare function getSiteStyleVars(theme: Theme): StyleVars;
+export declare function setColorScheme(theme: Theme): void;
+export declare function watchTheme(cb: (theme: Theme, from: 'pc' | 'mobile' | 'default' | 'playground') => void, shouldUnmount?: boolean): void;
+export declare function getMobileIndex(): "/mobile.html" | "./mobile" | "./mobile.html";
+export { AppType, ThemeProvider };
+export { normalizeLanguage, getSavedLanguage, saveLanguage, createDemoMessages } from './language';