@uni-helper/vite-plugin-uni-pages 0.0.7 → 0.1.0

package/dist/index.d.ts

@@ -1,374 +1,326 @@
-import { Plugin } from 'vite';
-import { PartialDeep } from 'type-fest';
+import { Logger, ViteDevServer, Plugin } from 'vite';
+import { FSWatcher } from 'fs';
+import Debug from 'debug';
+import { SFCDescriptor, SFCBlock } from '@vue/compiler-sfc';
 
-interface Easycom {
+interface EasyCom {
     autoscan: boolean;
     custom: Record<string, string>;
 }
 
-type hexcolor = string;
+type HEXColor = `#${string}`;
 
 interface AppPlus {
     /**
      * 窗体背景色。无论vue页面还是nvue页面，在App上都有一个父级原生窗体，该窗体的背景色生效时间快于页面里的css生效时间
-     * @type HexColor
      * @default "#FFFFFF"
      * @desc App
      */
-    background: hexcolor;
+    background?: HEXColor;
     /**
-     * 导航栏 ，详见:导航栏
-     * @type Object
+     * 导航栏 ，详见?:导航栏
      * @desc App、H5
      */
-    titleNView: object;
+    titleNView?: object;
     /**
-     * 原生子窗体，详见:原生子窗体
-     * @type Object
+     * 原生子窗体，详见?:原生子窗体
      * @desc App 1.9.10+
      */
-    subNVues: object;
+    subNVues?: object;
     /**
      * 页面回弹效果，设置为 "none" 时关闭效果。
-     * @type String
      * @desc App-vue（nvue Android无页面级bounce效果，仅list、recycle-list、waterfall等滚动组件有bounce效果）
      */
-    bounce: string;
+    bounce?: string;
     /**
      * 侧滑返回功能，可选值："close"（启用侧滑返回）、"none"（禁用侧滑返回）
-     * @type String
      * @default "close"
      * @desc App-iOS
      */
-    popGesture: string;
+    popGesture?: string;
     /**
      * iOS软键盘上完成工具栏的显示模式，设置为 "none" 时关闭工具栏。
-     * @type String
      * @default "auto"
      * @desc App-iOS
      */
-    softinputNavBar: string;
+    softInputNavBar?: string;
     /**
      * 软键盘弹出模式，支持 adjustResize、adjustPan 两种模式
-     * @type String
      * @default "adjustPan"
      * @desc App
      */
-    softinputMode: string;
+    softInputMode?: string;
     /**
      * 下拉刷新
-     * @type Object
      * @desc App
      */
-    pullToRefresh: object;
+    pullToRefresh?: object;
     /**
      * 滚动条显示策略，设置为 "none" 时不显示滚动条。
-     * @type String
      * @desc App
      */
-    scrollIndicator: string;
+    scrollIndicator?: string;
     /**
      * 窗口显示的动画效果，详见：窗口动画。
-     * @type String
      * @default "pop-in"
      * @desc App
      */
-    animationType: string;
+    animationType?: string;
     /**
      * 窗口显示动画的持续时间，单位为 ms。
-     * @type Number
      * @default "300"
      * @desc App
      */
-    animationDuration: number;
+    animationDuration?: number;
     [x: string]: any;
 }
+
 interface H5 {
     /**
      * 背景颜色，颜色值格式为"#RRGGBB"。
-     * @type String
      * @default "#F7F7F7"
      * @desc
      */
-    backgroundColor: string;
+    backgroundColor?: HEXColor;
     /**
      * 自定义按钮，参考 buttons
-     * @type Array
      * @desc
      */
-    buttons: any[];
+    buttons?: any[];
     /**
      * 标题文字颜色
-     * @type String
      * @default "#000000"
      * @desc
      */
-    titleColor: string;
+    titleColor?: HEXColor;
     /**
      * 标题文字内容
-     * @type String
      * @desc
      */
-    titleText: string;
+    titleText?: string;
     /**
      * 标题文字字体大小
-     * @type String
      * @desc
      */
-    titleSize: string;
+    titleSize?: string;
     /**
      * 导航栏样式。"default"-默认样式；"transparent"-透明渐变。
-     * @type String
      * @default "default"
      * @desc
      */
-    type: string;
+    type?: string;
     /**
      * 导航栏上的搜索框样式，详见：searchInput
-     * @type Object
      * @desc 1.6.5
      */
-    searchInput: object;
+    searchInput?: object;
     [x: string]: any;
 }
+
 interface GlobalStyle {
     /**
      * 导航栏背景颜色（同状态栏背景色）
-     * @type HexColor
      * @default "#F7F7F7"
      * @desc APP与H5为#F7F7F7，小程序平台请参考相应小程序文档
      */
-    navigationBarBackgroundColor: hexcolor;
+    navigationBarBackgroundColor?: HEXColor;
     /**
      * 导航栏标题颜色及状态栏前景颜色，仅支持 black/white
-     * @type String
      * @default "white"
      * @desc 支付宝小程序不支持，请使用 my.setNavigationBar
      */
-    navigationBarTextStyle: string;
+    navigationBarTextStyle?: string;
     /**
      * 导航栏标题文字内容
-     * @type String
      * @desc
      */
-    navigationBarTitleText: string;
+    navigationBarTitleText?: string;
     /**
      * 导航栏样式，仅支持 default/custom。custom即取消默认的原生导航栏，需看使用注意
-     * @type String
      * @default "default"
      * @desc 微信小程序 7.0+、百度小程序、H5、App（2.0.3+）
      */
-    navigationStyle: string;
+    navigationStyle?: string;
     /**
      * 下拉显示出来的窗口的背景色
-     * @type HexColor
      * @default "#ffffff"
      * @desc 微信小程序
      */
-    backgroundColor: hexcolor;
+    backgroundColor?: HEXColor;
     /**
      * 下拉 loading 的样式，仅支持 dark / light
-     * @type String
      * @default "dark"
      * @desc 微信小程序
      */
-    backgroundTextStyle: string;
+    backgroundTextStyle?: string;
     /**
      * 是否开启下拉刷新，详见页面生命周期。
-     * @type Boolean
      * @default "false"
      * @desc
      */
-    enablePullDownRefresh: boolean;
+    enablePullDownRefresh?: boolean;
     /**
      * 页面上拉触底事件触发时距页面底部距离，单位只支持px，详见页面生命周期
-     * @type Number
      * @default "50"
      * @desc
      */
-    onReachBottomDistance: number;
+    onReachBottomDistance?: number;
     /**
      * 顶部窗口的背景色（bounce回弹区域）
-     * @type HexColor
      * @default "#ffffff"
      * @desc 仅 iOS 平台
      */
-    backgroundColorTop: hexcolor;
+    backgroundColorTop?: HEXColor;
     /**
      * 底部窗口的背景色（bounce回弹区域）
-     * @type HexColor
      * @default "#ffffff"
      * @desc 仅 iOS 平台
      */
-    backgroundColorBottom: hexcolor;
+    backgroundColorBottom?: HEXColor;
     /**
      * 导航栏图片地址（替换当前文字标题），支付宝小程序内必须使用https的图片链接地址
-     * @type String
      * @desc 支付宝小程序、H5、APP
      */
-    titleImage: string;
+    titleImage?: string;
     /**
      * 导航栏整体（前景、背景）透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明
-     * @type String
      * @default "none"
      * @desc 支付宝小程序、H5、APP
      */
-    transparentTitle: string;
+    transparentTitle?: string;
     /**
      * 导航栏点击穿透
-     * @type String
      * @default "NO"
      * @desc 支付宝小程序、H5
      */
-    titlePenetrate: string;
+    titlePenetrate?: string;
     /**
      * 横屏配置，屏幕旋转设置，仅支持 auto / portrait / landscape 详见 响应显示区域变化
-     * @type String
      * @default "portrait"
      * @desc App 2.4.7+、微信小程序、QQ小程序
      */
-    pageOrientation: string;
+    pageOrientation?: string;
     /**
      * 窗口显示的动画效果，详见：窗口动画
-     * @type String
      * @default "pop-in"
      * @desc App
      */
-    animationType: string;
+    animationType?: string;
     /**
      * 窗口显示动画的持续时间，单位为 ms
-     * @type Number
      * @default "300"
      * @desc App
      */
-    animationDuration: number;
+    animationDuration?: number;
     /**
      * 设置编译到 App 平台的特定样式，配置项参考下方 app-plus
-     * @type AppPlus
      * @desc App
      */
-    "app-plus": AppPlus;
+    'app-plus'?: AppPlus;
     /**
      * 设置编译到 H5 平台的特定样式，配置项参考下方 H5
      * @type H5
      * @desc H5
      */
-    h5: H5;
+    h5?: H5;
     /**
      * 设置编译到 mp-alipay 平台的特定样式，配置项参考下方 MP-ALIPAY
-     * @type Object
      * @desc 支付宝小程序
      */
-    "mp-alipay": object;
+    'mp-alipay'?: object;
     /**
      * 设置编译到 mp-weixin 平台的特定样式
-     * @type Object
      * @desc 微信小程序
      */
-    "mp-weixin": object;
+    'mp-weixin'?: object;
     /**
      * 设置编译到 mp-baidu 平台的特定样式
-     * @type Object
      * @desc 百度小程序
      */
-    "mp-baidu": object;
+    'mp-baidu'?: object;
     /**
      * 设置编译到 mp-toutiao 平台的特定样式
-     * @type Object
      * @desc 字节跳动小程序
      */
-    "mp-toutiao": object;
+    'mp-toutiao'?: object;
     /**
      * 设置编译到 mp-lark 平台的特定样式
-     * @type Object
      * @desc 飞书小程序
      */
-    "mp-lark": object;
+    'mp-lark'?: object;
     /**
      * 设置编译到 mp-qq 平台的特定样式
-     * @type Object
      * @desc QQ小程序
      */
-    "mp-qq": object;
+    'mp-qq'?: object;
     /**
      * 设置编译到 mp-kuaishou 平台的特定样式
-     * @type Object
      * @desc 快手小程序
      */
-    "mp-kuaishou": object;
+    'mp-kuaishou'?: object;
     /**
      * 设置编译到 mp-jd 平台的特定样式
-     * @type Object
      * @desc 京东小程序
      */
-    "mp-jd": object;
+    'mp-jd'?: object;
     /**
      * 引用小程序组件，参考 小程序组件
      * @type Record<string, string>
      * @desc
      */
-    usingComponents: Record<string, string>;
+    usingComponents?: Record<string, string>;
     /**
      * 同层渲染，webrtc(实时音视频) 无法正常时尝试配置 seperated 强制关掉同层
-     * @type String
      * @desc 微信小程序
      */
-    renderingMode: string;
+    renderingMode?: string;
     /**
      * 当存在 leftWindow 时，默认是否显示 leftWindow
-     * @type Boolean
      * @default "true"
      * @desc H5
      */
-    leftWindow: boolean;
+    leftWindow?: boolean;
     /**
      * 当存在 topWindow 时，默认是否显示 topWindow
-     * @type Boolean
      * @default "true"
      * @desc H5
      */
-    topWindow: boolean;
+    topWindow?: boolean;
     /**
      * 当存在 rightWindow 时，默认是否显示 rightWindow
-     * @type Boolean
      * @default "true"
      * @desc H5
      */
-    rightWindow: boolean;
+    rightWindow?: boolean;
     /**
      * rpx 计算所支持的最大设备宽度，单位 px
-     * @type Number
      * @default "960"
      * @desc App（vue2 且不含 nvue）、H5（2.8.12+）
      */
-    rpxCalcMaxDeviceWidth: number;
+    rpxCalcMaxDeviceWidth?: number;
     /**
      * rpx 计算使用的基准设备宽度，设备实际宽度超出 rpx 计算所支持的最大设备宽度时将按基准宽度计算，单位 px
-     * @type Number
      * @default "375"
      * @desc App（vue2 且不含 nvue）、H5（2.8.12+）
      */
-    rpxCalcBaseDeviceWidth: number;
+    rpxCalcBaseDeviceWidth?: number;
     /**
      * rpx 计算特殊处理的值，始终按实际的设备宽度计算，单位 rpx
-     * @type Number
      * @default "750"
      * @desc App（vue2 且不含 nvue）、H5（2.8.12+）
      */
-    rpxCalcIncludeWidth: number;
+    rpxCalcIncludeWidth?: number;
     /**
      * 动态 rpx，屏幕大小变化会重新渲染 rpx
-     * @type Boolean
      * @default "false"
      * @desc App-nvue（vue3 固定值为 true） 3.2.13+
      */
-    dynamicRpx: boolean;
+    dynamicRpx?: boolean;
     /**
      * 单位px，当浏览器可见区域宽度大于maxWidth时，两侧留白，当小于等于maxWidth时，页面铺满；不同页面支持配置不同的maxWidth；maxWidth = leftWindow(可选)+page(页面主体)+rightWindow(可选)
-     * @type Number
      * @desc H5（2.9.9+）
      */
-    maxWidth: number;
+    maxWidth?: number;
     [x: string]: any;
 }
 
@@ -376,195 +328,160 @@ interface IconFont {
     /**
      * 字库 Unicode 码
      */
-    text: string;
+    text?: string;
     /**
      * 选中后字库 Unicode 码
      */
-    selectedText: string;
+    selectedText?: string;
     /**
      * 字体图标字号(px)
      */
-    fontSize: string;
+    fontSize?: string;
     /**
      * 字体图标颜色
      */
-    color: string;
+    color?: string;
     /**
      * 字体图标选中颜色
      */
-    selectedColor: string;
+    selectedColor?: string;
 }
 interface TabBarItem {
     /**
      * 页面路径，必须在 pages 中先定义
-     * @type String
      */
-    pagePath: string;
+    pagePath?: string;
     /**
      * tab 上按钮文字，在 App 和 H5 平台为非必填。例如中间可放一个没有文字的+号图标
-     * @type String
      */
-    text: string;
+    text?: string;
     /**
-     * 图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px，当 position 为 top 时，此参数无效，不支持网络图片，不支持字体图标
-     * @type String
+     * 图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px，
+     * 当 position 为 top 时，此参数无效，不支持网络图片，不支持字体图标
      */
-    iconPath: string;
+    iconPath?: string;
     /**
      * 选中时的图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px ，当 position 为 top 时，此参数无效
-     * @type String
      */
-    selectedIconPath: string;
+    selectedIconPath?: string;
     /**
      * 该项是否显示，默认显示
-     * @type Boolean
      * @desc App (3.2.10+)、H5 (3.2.10+)
      */
-    visible: boolean;
+    visible?: boolean;
     /**
      * 字体图标，优先级高于 iconPath
-     * @type IconFont
      * @desc App（3.4.4+）、H5 (3.5.3+)
      */
-    iconfont: IconFont;
+    iconfont?: IconFont;
     [x: string]: any;
 }
 interface MidButton {
     /**
      * 中间按钮的宽度，tabBar 其它项为减去此宽度后平分，默认值为与其它项平分宽度
-     * @type String
      * @default "80px"
      */
-    width: string;
+    width?: string;
     /**
      * 中间按钮的高度，可以大于 tabBar 高度，达到中间凸起的效果
-     * @type String
      * @default "50px"
      */
-    height: string;
+    height?: string;
     /**
      * 中间按钮的文字
-     * @type String
      */
-    text: string;
+    text?: string;
     /**
      * 中间按钮的图片路径
-     * @type String
      */
-    iconPath: string;
+    iconPath?: string;
     /**
      * 图片宽度（高度等比例缩放）
-     * @type String
      * @default "24px"
      */
-    iconWidth: string;
+    iconWidth?: string;
     /**
      * 中间按钮的背景图片路径
-     * @type String
      */
-    backgroundImage: string;
+    backgroundImage?: string;
     /**
      * 字体图标，优先级高于 iconPath
-     * @type IconFont
      */
-    iconfont: IconFont;
+    iconfont?: IconFont;
 }
 interface TabBar {
     /**
      * tab 上的文字默认颜色
-     * @type HexColor
      */
-    color: hexcolor;
+    color?: HEXColor;
     /**
      * tab 上的文字选中时的颜色
-     * @type HexColor
      */
-    selectedColor: hexcolor;
+    selectedColor?: HEXColor;
     /**
      * tab 的背景色
-     * @type HexColor
      */
-    backgroundColor: hexcolor;
+    backgroundColor?: HEXColor;
     /**
      * tabbar 上边框的颜色，可选值 black/white，也支持其他颜色值
-     * @type String
      * @default "black"
      * @desc App 2.3.4+ 、H5 3.0.0+
      */
-    borderStyle: string;
+    borderStyle?: string;
     /**
-     * iOS 高斯模糊效果，可选值 dark/extralight/light/none（参考:使用说明）
-     * @type String
+     * iOS 高斯模糊效果，可选值 dark/extralight/light/none（参考?:使用说明）
      * @default "none"
      * @desc App 2.4.0+ 支持、H5 3.0.0+（只有最新版浏览器才支持）
      */
-    blurEffect: string;
+    blurEffect?: string;
     /**
      * tab 的列表，详见 list 属性说明，最少2个、最多5个 tab
      * @type TabBarItem[]
      */
-    list: PartialDeep<TabBarItem>[];
+    list?: TabBarItem[];
     /**
      * 可选值 bottom、top
-     * @type String
      * @default "bottom"
      * @desc top 值仅微信小程序支持
      */
-    position: string;
+    position?: string;
     /**
      * 文字默认大小
-     * @type String
      * @default "10px"
      * @desc App 2.3.4+、H5 3.0.0+
      */
-    fontSize: string;
+    fontSize?: string;
     /**
      * 图标默认宽度（高度等比例缩放）
-     * @type String
      * @default "24px"
      * @desc App 2.3.4+、H5 3.0.0+
      */
-    iconWidth: string;
+    iconWidth?: string;
     /**
      * 图标和文字的间距
-     * @type String
      * @default "3px"
      * @desc App 2.3.4+、H5 3.0.0+
      */
-    spacing: string;
+    spacing?: string;
     /**
      * tabBar 默认高度
-     * @type String
      * @default "50px"
      * @desc App 2.3.4+、H5 3.0.0+
      */
-    height: string;
+    height?: string;
     /**
      * 中间按钮 仅在 list 项为偶数时有效
-     * @type MidButton
      * @desc App 2.3.4+、H5 3.0.0+
      */
-    midButton: MidButton;
+    midButton?: MidButton;
     /**
      * list设置 iconfont 属性时，需要指定字体文件路径
-     * @type String
      * @desc App 3.4.4+、H5 3.5.3+
      */
-    iconfontSrc: string;
+    iconfontSrc?: string;
     [x: string]: any;
 }
 
-interface Page {
-    /**
-     * 配置页面路径
-     */
-    path: string;
-    /**
-     * 配置页面窗口表现，配置项参考下方 pageStyle
-     */
-    style: GlobalStyle;
-    [x: string]: any;
-}
 interface TheWindow {
     /**
      * 配置页面路径
@@ -573,45 +490,44 @@ interface TheWindow {
     /**
      * 配置页面窗口表现，配置项参考下方 pageStyle
      */
-    style: GlobalStyle;
+    style?: GlobalStyle;
     /**
      * 配置显示该窗口的规则，配置项参考下方 matchMedia
      */
-    matchMedia: {
+    matchMedia?: {
         /**
          * 当设备可见区域宽度 >= minWidth 时，显示该 window
-         * @type number
          * @default "768"
          */
-        minWidth: number;
+        minWidth?: number;
     };
 }
 interface PreloadRule {
     /**
      * 进入页面后预下载分包的 root 或 name。__APP__ 表示主包。
      */
-    packages: string[];
+    packages?: string[];
     /**
      * 在指定网络下预下载，可选值为：all（不限网络）、wifi（仅wifi下预下载）
      * @default "wifi"
      */
-    network: string;
+    network?: string;
 }
 interface SubPackage {
     /**
      * 子包的根目录
      */
-    root: string;
+    root?: string;
     /**
      * 子包由哪些页面组成，参数同 pages
      */
-    pages: any[];
+    pages?: any[];
 }
 interface ConditionItem {
     /**
      * 启动模式名称
      */
-    name: string;
+    name?: string;
     /**
      * 启动页面路径
      */
@@ -619,100 +535,116 @@ interface ConditionItem {
     /**
      * 启动参数，可在页面的 onLoad 函数里获得
      */
-    query: string;
+    query?: string;
 }
 interface Condition {
     /**
      * 当前激活的模式，list节点的索引值
      */
-    current: number;
+    current?: number;
     /**
      * 启动模式列表
      */
-    list: Partial<ConditionItem>[];
+    list?: Partial<ConditionItem>[];
 }
 interface PagesConfig {
     /**
      * 设置页面路径及窗口表现
      */
-    pages: PartialDeep<Page>[];
+    pages?: PageMetaDatum[];
     /**
      * 设置默认页面的窗口表现
      */
-    globalStyle: GlobalStyle;
+    globalStyle?: GlobalStyle;
     /**
      * 组件自动引入规则
      * @desc 2.5.5+
      */
-    easycom: Easycom;
+    easycom?: EasyCom;
     /**
      * 设置底部 tab 的表现
      */
-    tabBar: TabBar;
+    tabBar?: TabBar;
     /**
      * 启动模式配置
      */
-    condition: Condition;
+    condition?: Condition;
     /**
      * 分包加载配置
      */
-    subPackages: PartialDeep<SubPackage>[];
+    subPackages?: SubPackage[];
     /**
      * 分包预下载规则
      * @desc 微信小程序
      */
-    preloadRule: PreloadRule;
+    preloadRule?: PreloadRule;
     /**
      * `Worker` 代码放置的目录
      * @desc 微信小程序
      */
-    workers: any;
+    workers?: any;
     /**
      * 大屏左侧窗口
      * @desc H5
      */
-    leftWindow: TheWindow;
+    leftWindow?: TheWindow;
     /**
      * 大屏顶部窗口
      * @desc H5
      */
-    topWindow: TheWindow;
+    topWindow?: TheWindow;
     /**
      * 大屏右侧窗口
      * @desc H5
      */
-    rightWindow: TheWindow;
+    rightWindow?: TheWindow;
     /**
      * 自动跳转相关配置，新增于HBuilderX 3.5.0
      */
-    uniIdRouter: any;
+    uniIdRouter?: any;
     [x: string]: any;
 }
-interface UserPagesConfig extends PartialDeep<PagesConfig> {
+interface UserPagesConfig extends PagesConfig {
 }
 
-declare class Context {
+declare function defineUniPages(config: UserPagesConfig): UserPagesConfig;
+
+declare class PageContext {
+    private _server;
+    pagesGlobConfig: PagesConfig | undefined;
+    pagesPath: PagePath[];
+    pageMetaData: PageMetaDatum[];
+    resolvedPagesJSONPath: string;
+    rawOptions: UserOptions;
+    root: string;
     options: ResolvedOptions;
-    pagesConfig: PagesConfig;
-    pagesPathInfo: PagePathInfo[];
-    pagesMeta: PageMeta[];
-    constructor(options: ResolvedOptions);
+    logger?: Logger;
+    constructor(userOptions: UserOptions, viteRoot?: string);
+    setLogger(logger: Logger): void;
     loadUserPagesConfig(): Promise<void>;
     scanPages(): Promise<void>;
-    parsePage({ relative, absolute }: PagePathInfo): Promise<PageMeta>;
-    mergePagesMeta(): Promise<void>;
-    createOrUpdatePagesJSON(): Promise<void>;
+    setupViteServer(server: ViteDevServer): void;
+    setupWatcher(watcher: FSWatcher): void;
+    onUpdate(): void;
+    parsePage(page: PagePath): Promise<PageMetaDatum>;
+    mergePageMetaData(): Promise<void>;
+    updatePagesJSON(): Promise<void>;
     virtualModule(): Promise<string>;
-    pagesConfigSourcePaths(): Promise<string[]>;
-    get pagesJson(): string;
+    resolveRoutes(): string;
 }
 
+type CustomBlock = Record<string, any>;
 interface Options {
     /**
-     * pages dir
-     * @default "src/pages"
+     * Whether to merge pages in pages.json
+     * @default true
+     */
+    mergePages: boolean;
+    /**
+     * Paths to the directory to search for page components.
+     * @default 'src/pages'
      */
-    pagesDir: string;
+    dir: string;
     /**
      * pages.json dir
      * @default "src"
@@ -723,31 +655,89 @@ interface Options {
      * @default []
      */
     exclude: string[];
-    onBeforeLoadUserConfig: (ctx: Context) => void;
-    onAfterLoadUserConfig: (ctx: Context) => void;
-    onBeforeScanPages: (ctx: Context) => void;
-    onAfterScanPages: (ctx: Context) => void;
-    onBeforeMergePagesMeta: (ctx: Context) => void;
-    onAfterMergePagesMeta: (ctx: Context) => void;
-    onBeforeWriteFile: (ctx: Context) => void;
-    onAfterWriteFile: (ctx: Context) => void;
-}
-interface UserOptions extends Partial<Options> {
+    /**
+     * Set the default route block parser, or use `<route lang="xxx">` in SFC route block
+     * @default 'json5'
+     */
+    routeBlockLang: 'json5' | 'json' | 'yaml' | 'yml';
+    onBeforeLoadUserConfig: (ctx: PageContext) => void;
+    onAfterLoadUserConfig: (ctx: PageContext) => void;
+    onBeforeScanPages: (ctx: PageContext) => void;
+    onAfterScanPages: (ctx: PageContext) => void;
+    onBeforeMergePageMetaData: (ctx: PageContext) => void;
+    onAfterMergePageMetaData: (ctx: PageContext) => void;
+    onBeforeWriteFile: (ctx: PageContext) => void;
+    onAfterWriteFile: (ctx: PageContext) => void;
 }
-interface ResolvedOptions extends Options {
+type UserOptions = Partial<Options>;
+interface ResolvedOptions extends Omit<Options, 'dir'> {
+    /**
+     * Resolves to the `root` value from Vite config.
+     * @default config.root
+     */
+    root: string;
+    /**
+     * Resolved page dirs
+     */
+    dirs: string[];
 }
-interface PagePathInfo {
-    relative: string;
-    absolute: string;
+interface PagePath {
+    relativePath: string;
+    absolutePath: string;
 }
-interface PageMeta {
+interface PageMetaDatum {
+    /**
+     * 配置页面路径
+     */
     path: string;
-    type: string;
+    type?: string;
+    /**
+     * 配置页面窗口表现，配置项参考下方 pageStyle
+     */
+    style?: GlobalStyle;
     [x: string]: any;
 }
 
-declare function definePages(config: UserPagesConfig): UserPagesConfig;
+declare const MODULE_ID_VIRTUAL = "virtual:uni-pages";
+declare const RESOLVED_MODULE_ID_VIRTUAL: string;
+declare const OUTPUT_NAME = "pages.json";
+declare const FILE_EXTENSIONS: string[];
+
+declare function invalidatePagesModule(server: ViteDevServer): void;
+declare const debug: {
+    hmr: Debug.Debugger;
+    routeBlock: Debug.Debugger;
+    options: Debug.Debugger;
+    pages: Debug.Debugger;
+    error: Debug.Debugger;
+};
+declare function extsToGlob(extensions: string[]): string;
+declare function isTargetFile(path: string): boolean;
+declare function isConfigFile(path: string): boolean;
+/**
+ * merge page meta data array by path and assign style
+ * @param pageMetaData  page meta data array
+ * TODO: support merge middleware
+ */
+declare function mergePageMetaDataArray(pageMetaData: PageMetaDatum[]): PageMetaDatum[];
+
+/**
+ * Resolves the files that are valid pages for the given context.
+ */
+declare function getPageFiles(path: string, options: ResolvedOptions): string[];
+declare function checkPagesJsonFile(path: string): void;
+declare function writeFileSync(path: string, content: string): void;
+
+declare function resolveOptions(userOptions: UserOptions, viteRoot?: string): ResolvedOptions;
+/**
+ * Resolves the page dirs for its for its given globs
+ */
+declare function resolvePageDirs(dir: string, root: string, exclude: string[]): string[];
+
+declare function parseSFC(code: string): Promise<SFCDescriptor>;
+declare function parseCustomBlock(block: SFCBlock, filePath: string, options: ResolvedOptions): any;
+declare function getRouteBlock(path: string, options: ResolvedOptions): Promise<CustomBlock | undefined>;
 
-declare const VitePluginUniPages: (userOptions?: UserOptions) => Promise<Plugin>;
+declare const VitePluginUniPages: (userOptions?: UserOptions) => Plugin;
 
-export { AppPlus, Condition, ConditionItem, Easycom, GlobalStyle, H5, IconFont, MidButton, Page, PagesConfig, PreloadRule, SubPackage, TabBar, TabBarItem, TheWindow, UserPagesConfig, VitePluginUniPages, VitePluginUniPages as default, definePages };
+export { Condition, ConditionItem, CustomBlock, EasyCom, FILE_EXTENSIONS, GlobalStyle, IconFont, MODULE_ID_VIRTUAL, MidButton, OUTPUT_NAME, Options, PageContext, PageMetaDatum, PagePath, PagesConfig, PreloadRule, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackage, TabBar, TabBarItem, TheWindow, UserOptions, UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getRouteBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, writeFileSync };