@uni-helper/vite-plugin-uni-pages 0.1.3 → 0.1.5

package/dist/index.cjs

@@ -65,6 +65,13 @@ function mergePageMetaDataArray(pageMetaData) {
   }
   return result;
 }
+const getPagesConfigSourcePaths = async () => {
+  return await fg("pages.config.(ts|mts|cts|js|cjs|mjs|json)", {
+    deep: 0,
+    onlyFiles: true,
+    absolute: true
+  });
+};
 
 function resolveOptions(userOptions, viteRoot) {
   const {
@@ -250,7 +257,11 @@ class PageContext {
     this._server = server;
     this.setupWatcher(server.watcher);
   }
-  setupWatcher(watcher) {
+  async setupWatcher(watcher) {
+    if (process.env.UNI_PLATFORM !== "h5") {
+      const configs = await getPagesConfigSourcePaths();
+      watcher.add(configs);
+    }
     watcher.on("add", async (path2) => {
       path2 = slash(path2);
       if (!isTargetFile(path2))
@@ -392,6 +403,7 @@ exports.default = VitePluginUniPages;
 exports.defineUniPages = defineUniPages;
 exports.extsToGlob = extsToGlob;
 exports.getPageFiles = getPageFiles;
+exports.getPagesConfigSourcePaths = getPagesConfigSourcePaths;
 exports.getRouteBlock = getRouteBlock;
 exports.invalidatePagesModule = invalidatePagesModule;
 exports.isConfigFile = isConfigFile;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Logger, ViteDevServer, Plugin } from 'vite';
-import { FSWatcher } from 'fs';
+import { FSWatcher } from 'chokidar';
 import Debug from 'debug';
 import { SFCDescriptor, SFCBlock } from '@vue/compiler-sfc';
 
@@ -9,6 +9,7 @@ interface EasyCom {
 }
 
 type HEXColor = `#${string}`;
+type ThemeColor = `@${string}`;
 
 interface AppPlus {
     /**
@@ -123,7 +124,7 @@ interface GlobalStyle {
      * @default "#F7F7F7"
      * @desc APP与H5为#F7F7F7，小程序平台请参考相应小程序文档
      */
-    navigationBarBackgroundColor?: HEXColor;
+    navigationBarBackgroundColor?: HEXColor | ThemeColor;
     /**
      * 导航栏标题颜色及状态栏前景颜色，仅支持 black/white
      * @default "white"
@@ -146,7 +147,7 @@ interface GlobalStyle {
      * @default "#ffffff"
      * @desc 微信小程序
      */
-    backgroundColor?: HEXColor;
+    backgroundColor?: HEXColor | ThemeColor;
     /**
      * 下拉 loading 的样式，仅支持 dark / light
      * @default "dark"
@@ -170,13 +171,13 @@ interface GlobalStyle {
      * @default "#ffffff"
      * @desc 仅 iOS 平台
      */
-    backgroundColorTop?: HEXColor;
+    backgroundColorTop?: HEXColor | ThemeColor;
     /**
      * 底部窗口的背景色（bounce回弹区域）
      * @default "#ffffff"
      * @desc 仅 iOS 平台
      */
-    backgroundColorBottom?: HEXColor;
+    backgroundColorBottom?: HEXColor | ThemeColor;
     /**
      * 导航栏图片地址（替换当前文字标题），支付宝小程序内必须使用https的图片链接地址
      * @desc 支付宝小程序、H5、APP
@@ -513,6 +514,22 @@ interface PreloadRule {
      */
     network?: string;
 }
+interface UniIdRouter {
+    /**
+     * 登录页面路径
+     */
+    loginPage: string;
+    /**
+     * 需要登录才可以访问的页面列表，可以使用正则语法
+     */
+    needLogin: string[];
+    /**
+     * 是否自动解析云对象及 clientDB 的错误码，如果是客户端 token 不正确或 token 过期则自动跳转配置的登录页面
+     *
+     * @default true
+     */
+    resToLogin?: boolean;
+}
 interface SubPackage {
     /**
      * 子包的根目录
@@ -577,7 +594,9 @@ interface PagesConfig {
      * 分包预下载规则
      * @desc 微信小程序
      */
-    preloadRule?: PreloadRule;
+    preloadRule?: {
+        [path: string]: PreloadRule;
+    };
     /**
      * `Worker` 代码放置的目录
      * @desc 微信小程序
@@ -599,9 +618,13 @@ interface PagesConfig {
      */
     rightWindow?: TheWindow;
     /**
-     * 自动跳转相关配置，新增于HBuilderX 3.5.0
+     * 自动跳转相关配置，新增于 HBuilderX 3.5.0
      */
-    uniIdRouter?: any;
+    uniIdRouter?: UniIdRouter;
+    /**
+     * 默认启动首页，新增于 HBuilderX 3.7.0
+     */
+    entryPagePath?: string;
     [x: string]: any;
 }
 interface UserPagesConfig extends PagesConfig {
@@ -624,7 +647,7 @@ declare class PageContext {
     loadUserPagesConfig(): Promise<void>;
     scanPages(): Promise<void>;
     setupViteServer(server: ViteDevServer): void;
-    setupWatcher(watcher: FSWatcher): void;
+    setupWatcher(watcher: FSWatcher): Promise<void>;
     onUpdate(): void;
     parsePage(page: PagePath): Promise<PageMetaDatum>;
     mergePageMetaData(): Promise<void>;
@@ -698,6 +721,10 @@ interface PageMetaDatum {
      * 配置页面窗口表现，配置项参考下方 pageStyle
      */
     style?: GlobalStyle;
+    /**
+     * 当前页面是否需要登录才可以访问，此配置优先级高于 uniIdRouter 下的 needLogin
+     */
+    needLogin?: boolean;
     [x: string]: any;
 }
 
@@ -723,6 +750,7 @@ declare function isConfigFile(path: string): boolean;
  * TODO: support merge middleware
  */
 declare function mergePageMetaDataArray(pageMetaData: PageMetaDatum[]): PageMetaDatum[];
+declare const getPagesConfigSourcePaths: () => Promise<string[]>;
 
 /**
  * Resolves the files that are valid pages for the given context.
@@ -743,4 +771,4 @@ declare function getRouteBlock(path: string, options: ResolvedOptions): Promise<
 
 declare const VitePluginUniPages: (userOptions?: UserOptions) => Plugin;
 
-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 };
+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, UniIdRouter, UserOptions, UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getPagesConfigSourcePaths, getRouteBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, writeFileSync };

package/dist/index.mjs

@@ -61,6 +61,13 @@ function mergePageMetaDataArray(pageMetaData) {
   }
   return result;
 }
+const getPagesConfigSourcePaths = async () => {
+  return await fg("pages.config.(ts|mts|cts|js|cjs|mjs|json)", {
+    deep: 0,
+    onlyFiles: true,
+    absolute: true
+  });
+};
 
 function resolveOptions(userOptions, viteRoot) {
   const {
@@ -246,7 +253,11 @@ class PageContext {
     this._server = server;
     this.setupWatcher(server.watcher);
   }
-  setupWatcher(watcher) {
+  async setupWatcher(watcher) {
+    if (process.env.UNI_PLATFORM !== "h5") {
+      const configs = await getPagesConfigSourcePaths();
+      watcher.add(configs);
+    }
     watcher.on("add", async (path2) => {
       path2 = slash(path2);
       if (!isTargetFile(path2))
@@ -376,4 +387,4 @@ const VitePluginUniPages = (userOptions = {}) => {
   };
 };
 
-export { FILE_EXTENSIONS, MODULE_ID_VIRTUAL, OUTPUT_NAME, PageContext, RESOLVED_MODULE_ID_VIRTUAL, VitePluginUniPages, checkPagesJsonFile, debug, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getRouteBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, writeFileSync };
+export { FILE_EXTENSIONS, MODULE_ID_VIRTUAL, OUTPUT_NAME, PageContext, RESOLVED_MODULE_ID_VIRTUAL, VitePluginUniPages, checkPagesJsonFile, debug, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getPagesConfigSourcePaths, getRouteBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, writeFileSync };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@uni-helper/vite-plugin-uni-pages",
   "type": "module",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "packageManager": "pnpm@7.16.1",
   "description": "File system based routing for uni-app applications using Vite",
   "author": "KeJun",