@univa/core 0.0.5 → 0.0.7

package/dist/index.d.cts

@@ -1,40 +1,189 @@
+import { PagesConfig } from '@uni-helper/uni-pages-types';
+export { Condition, EasyCom, GlobalStyle, PageMetaDatum, PagesConfig, SubPackage, TabBar, TabBarItem } from '@uni-helper/uni-pages-types';
+import { Options } from '@uni-helper/vite-plugin-uni-components';
+export { ComponentInfo, ComponentResolver, Options as ComponentsOptions, ResolvedOptions as ComponentsResolvedOptions, ImportInfo, default as VitePluginUniComponents, camelCase, kebabCase, pascalCase } from '@uni-helper/vite-plugin-uni-components';
+import { UserOptions } from '@uni-helper/vite-plugin-uni-pages';
+export { PageContext, PagePath, UserOptions as PagesPluginOptions, ResolvedOptions as PagesResolvedOptions, SubPageMetaDatum, VitePluginUniPages, definePage } from '@uni-helper/vite-plugin-uni-pages';
+import { Options as Options$1 } from 'unplugin-auto-import/types';
+export { Options as AutoImportOptions } from 'unplugin-auto-import/types';
 import { PluginOption } from 'vite';
-import { Options as Options$1 } from '@uni-helper/vite-plugin-uni-components';
-import { UserPagesConfig as UserPagesConfig$1 } from '@uni-helper/vite-plugin-uni-pages';
-import { UserManifestConfig } from '@univa/manifest';
-import { Options } from 'unplugin-auto-import/types';
-import { Preset } from 'unocss';
+export { presetUni } from '@uni-helper/unocss-preset-uni';
+export { VitePluginUniLayouts } from '@uni-helper/vite-plugin-uni-layouts';
+export { default as UniKuRoot } from '@uni-ku/root';
+export { default as AutoImport } from 'unplugin-auto-import/vite';
 
 /**
- * NONE: 不需要tabbar
- * NATIVE: 原生tabbar
- * CUSTOM: 自定义tabbar
+ * Univa 类型定义统一导出
+ *
+ * 设计哲学：融合约定为主路径，overrides 为底层逃生口
+ * - 高层字段（dirs/imports）面向 90% 用户，降低心智成本
+ * - overrides 逃生口面向 10% 高级用户，可下沉到底层插件选项
  */
-type TabBarMode = 'NONE' | 'NATIVE' | 'CUSTOM';
-interface UserPagesConfig extends UserPagesConfig$1 {
-    tabBarMode?: TabBarMode;
+
+/**
+ * 目录约定（相对 srcDir）
+ */
+interface UnivaDirs {
+    /** 主包页面目录，默认 'pages' */
+    pages?: string;
+    /** 分包页面根目录列表，默认扫描 'pages-sub/' 下第一层目录 */
+    subPackages?: string[];
+    /** 布局目录，默认 'layouts' */
+    layouts?: string;
 }
-interface DefinePagesConfig extends UserPagesConfig {
+/**
+ * 自动导入配置
+ */
+interface UnivaImports {
+    /**
+     * 自动导入源，统一配置预设导入与目录扫描
+     *
+     * 支持三种形式：
+     * - 预设名（字符串）：`'vue'`、`'uni-app'`、`'pinia'`、`'@vueuse/core'`
+     * - 目录 glob（字符串）：`'composables/**'`、`'stores/**'`（相对 srcDir）
+     *   - 支持 negation 前缀 `!` 排除特定路径
+     * - inline preset（对象）：`{ from: 'wot-design-uni', imports: ['useToast'] }`
+     *   - 或命名导入映射：`{ '@fun-design/use': ['useState', 'useVModel'] }`
+     *
+     * 内部自动区分：含 glob 字符或路径分隔符的字符串 → 目录扫描，否则 → 预设导入。
+     * 对象形式统一作为 inline preset 传给 unplugin-auto-import。
+     */
+    apis?: Array<string | Record<string, unknown>>;
+    /**
+     * 组件自动导入源
+     *
+     * glob 模式，相对 srcDir。默认 ['components/**', 'components-biz/**']
+     */
+    components?: string[];
 }
-interface PagesOptions {
-    exclude?: string[];
-    subPackages?: string[];
-    config?: UserPagesConfig;
+/**
+ * 解析后的目录约定（字段必填，已应用默认值）
+ */
+interface ResolvedUnivaDirs {
+    pages: string;
+    subPackages: string[];
+    layouts: string;
+}
+/**
+ * 解析后的自动导入配置（字段必填，已应用默认值）
+ */
+interface ResolvedUnivaImports {
+    apis: Array<string | Record<string, unknown>>;
+    components: string[];
+}
+/**
+ * Layouts 模块底层选项（用于 overrides）
+ */
+interface LayoutsOptions {
+    layout?: string;
+    layoutDir?: string;
+    cwd?: string;
+}
+/**
+ * Root 模块底层选项（用于 overrides）
+ */
+interface RootOptions {
+    enabledVirtualHost?: boolean;
+    enabledGlobalRef?: boolean;
+    rootFileName?: string;
+    excludePages?: string | string[];
 }
+/**
+ * UnoCSS 模块底层选项（用于 overrides）
+ */
+interface UnoCSSOptions {
+    presets?: unknown[];
+    rules?: unknown[];
+    shortcuts?: Record<string, string | string[]>;
+}
+/**
+ * 底层插件逃生口
+ *
+ * 高级用户可通过此字段直接覆盖底层插件选项，优先级最高。
+ * 90% 场景下不需要使用此字段，请优先使用上层融合约定。
+ */
+interface UnivaOverrides {
+    /** @uni-helper/vite-plugin-uni-pages 完整选项 */
+    pages?: UserOptions;
+    /** @uni-helper/vite-plugin-uni-layouts 完整选项 */
+    layouts?: LayoutsOptions;
+    /** @uni-helper/vite-plugin-uni-components 完整选项 */
+    components?: Options;
+    /** @uni-ku/root 完整选项 */
+    root?: RootOptions;
+    /** unplugin-auto-import 完整选项 */
+    autoImport?: Options$1;
+    /** unocss/vite 完整选项 */
+    unocss?: UnoCSSOptions;
+}
+/**
+ * Univa 统一配置接口（工程级约定）
+ *
+ * 用于 univa.config.ts，声明项目工程结构、自动导入约定与应用级配置。
+ */
 interface UnivaOptions {
-    autoImport?: boolean | Options;
-    components?: boolean | Options$1;
-    pages?: PagesOptions;
-    appRoot?: boolean;
-    manifest?: UserManifestConfig;
+    /** 源码目录，相对 Vite root，默认 'src' */
+    srcDir?: string;
+    /** 目录约定，相对 srcDir */
+    dirs?: UnivaDirs;
+    /** 自动导入配置 */
+    imports?: UnivaImports;
+    /**
+     * 应用级 pages.json 配置（globalStyle / tabBar 等）
+     *
+     * Univa 会读取此字段自动生成 .univa/pages.ts，
+     * 供 VitePluginUniPages 消费。
+     *
+     * 注意：pages / subPackages 由目录扫描自动填充，请勿在此手写。
+     */
+    pages?: Partial<PagesConfig>;
+    /** 底层插件逃生口（覆盖融合层默认，高级用户使用） */
+    overrides?: UnivaOverrides;
 }
-interface UnivaUserConfig extends UnivaOptions {
+/**
+ * 解析后的完整配置（内部使用）
+ *
+ * 与 UnivaOptions 的差异：srcDir/dirs/imports 为必填（已应用默认值）。
+ * 所有路径保持相对 Vite root 的格式，由底层插件自行解析。
+ */
+interface ResolvedOptions extends Omit<UnivaOptions, 'dirs' | 'imports' | 'srcDir'> {
+    /** 源码目录（已应用默认值，相对 Vite root） */
+    srcDir: string;
+    /** 目录约定（已应用默认值，字段必填） */
+    dirs: ResolvedUnivaDirs;
+    /** 自动导入配置（已应用默认值，字段必填） */
+    imports: ResolvedUnivaImports;
 }
 
-declare function definePagesConfig(config: DefinePagesConfig): DefinePagesConfig;
-
-declare function presetUniva(): Preset;
+/**
+ * 声明 Univa 工程级约定
+ *
+ * 用于 `univa.config.ts`，声明项目工程结构、自动导入约定与应用级配置。
+ */
+declare function defineConfig(config: UnivaOptions): UnivaOptions;
 
-declare function Univa(config?: UnivaUserConfig): PluginOption[];
+/**
+ * 创建所有 Univa 插件
+ *
+ * 从 resolved options 提取高层约定（dirs/imports），拼接 srcDir 前缀后传给底层插件，
+ * 合并 overrides（优先级最高）。全部模块默认启用。
+ *
+ * 所有路径均为相对 Vite root 的格式，由底层插件自行解析为绝对路径。
+ */
+declare function createUnivaPlugins(resolved: ResolvedOptions): PluginOption[];
+/**
+ * Univa 插件入口函数（零参数）
+ *
+ * 工程约定与应用配置通过 `univa.config.ts` 声明，
+ * `.univa/pages.ts` 等产物自动生成。
+ *
+ * @example
+ * // vite.config.ts
+ * import { Univa } from '@univa/core'
+ * export default defineConfig({
+ *   plugins: [...Univa()],
+ * })
+ */
+declare function Univa(): PluginOption[];
 
-export { Univa, type UnivaOptions, type UnivaUserConfig, definePagesConfig, presetUniva };
+export { type LayoutsOptions, type ResolvedOptions, type ResolvedUnivaDirs, type ResolvedUnivaImports, type RootOptions, Univa, type UnivaDirs, type UnivaImports, type UnivaOptions, type UnivaOverrides, type UnoCSSOptions, createUnivaPlugins, defineConfig };

package/dist/index.d.ts

@@ -1,40 +1,189 @@
+import { PagesConfig } from '@uni-helper/uni-pages-types';
+export { Condition, EasyCom, GlobalStyle, PageMetaDatum, PagesConfig, SubPackage, TabBar, TabBarItem } from '@uni-helper/uni-pages-types';
+import { Options } from '@uni-helper/vite-plugin-uni-components';
+export { ComponentInfo, ComponentResolver, Options as ComponentsOptions, ResolvedOptions as ComponentsResolvedOptions, ImportInfo, default as VitePluginUniComponents, camelCase, kebabCase, pascalCase } from '@uni-helper/vite-plugin-uni-components';
+import { UserOptions } from '@uni-helper/vite-plugin-uni-pages';
+export { PageContext, PagePath, UserOptions as PagesPluginOptions, ResolvedOptions as PagesResolvedOptions, SubPageMetaDatum, VitePluginUniPages, definePage } from '@uni-helper/vite-plugin-uni-pages';
+import { Options as Options$1 } from 'unplugin-auto-import/types';
+export { Options as AutoImportOptions } from 'unplugin-auto-import/types';
 import { PluginOption } from 'vite';
-import { Options as Options$1 } from '@uni-helper/vite-plugin-uni-components';
-import { UserPagesConfig as UserPagesConfig$1 } from '@uni-helper/vite-plugin-uni-pages';
-import { UserManifestConfig } from '@univa/manifest';
-import { Options } from 'unplugin-auto-import/types';
-import { Preset } from 'unocss';
+export { presetUni } from '@uni-helper/unocss-preset-uni';
+export { VitePluginUniLayouts } from '@uni-helper/vite-plugin-uni-layouts';
+export { default as UniKuRoot } from '@uni-ku/root';
+export { default as AutoImport } from 'unplugin-auto-import/vite';
 
 /**
- * NONE: 不需要tabbar
- * NATIVE: 原生tabbar
- * CUSTOM: 自定义tabbar
+ * Univa 类型定义统一导出
+ *
+ * 设计哲学：融合约定为主路径，overrides 为底层逃生口
+ * - 高层字段（dirs/imports）面向 90% 用户，降低心智成本
+ * - overrides 逃生口面向 10% 高级用户，可下沉到底层插件选项
  */
-type TabBarMode = 'NONE' | 'NATIVE' | 'CUSTOM';
-interface UserPagesConfig extends UserPagesConfig$1 {
-    tabBarMode?: TabBarMode;
+
+/**
+ * 目录约定（相对 srcDir）
+ */
+interface UnivaDirs {
+    /** 主包页面目录，默认 'pages' */
+    pages?: string;
+    /** 分包页面根目录列表，默认扫描 'pages-sub/' 下第一层目录 */
+    subPackages?: string[];
+    /** 布局目录，默认 'layouts' */
+    layouts?: string;
 }
-interface DefinePagesConfig extends UserPagesConfig {
+/**
+ * 自动导入配置
+ */
+interface UnivaImports {
+    /**
+     * 自动导入源，统一配置预设导入与目录扫描
+     *
+     * 支持三种形式：
+     * - 预设名（字符串）：`'vue'`、`'uni-app'`、`'pinia'`、`'@vueuse/core'`
+     * - 目录 glob（字符串）：`'composables/**'`、`'stores/**'`（相对 srcDir）
+     *   - 支持 negation 前缀 `!` 排除特定路径
+     * - inline preset（对象）：`{ from: 'wot-design-uni', imports: ['useToast'] }`
+     *   - 或命名导入映射：`{ '@fun-design/use': ['useState', 'useVModel'] }`
+     *
+     * 内部自动区分：含 glob 字符或路径分隔符的字符串 → 目录扫描，否则 → 预设导入。
+     * 对象形式统一作为 inline preset 传给 unplugin-auto-import。
+     */
+    apis?: Array<string | Record<string, unknown>>;
+    /**
+     * 组件自动导入源
+     *
+     * glob 模式，相对 srcDir。默认 ['components/**', 'components-biz/**']
+     */
+    components?: string[];
 }
-interface PagesOptions {
-    exclude?: string[];
-    subPackages?: string[];
-    config?: UserPagesConfig;
+/**
+ * 解析后的目录约定（字段必填，已应用默认值）
+ */
+interface ResolvedUnivaDirs {
+    pages: string;
+    subPackages: string[];
+    layouts: string;
+}
+/**
+ * 解析后的自动导入配置（字段必填，已应用默认值）
+ */
+interface ResolvedUnivaImports {
+    apis: Array<string | Record<string, unknown>>;
+    components: string[];
+}
+/**
+ * Layouts 模块底层选项（用于 overrides）
+ */
+interface LayoutsOptions {
+    layout?: string;
+    layoutDir?: string;
+    cwd?: string;
+}
+/**
+ * Root 模块底层选项（用于 overrides）
+ */
+interface RootOptions {
+    enabledVirtualHost?: boolean;
+    enabledGlobalRef?: boolean;
+    rootFileName?: string;
+    excludePages?: string | string[];
 }
+/**
+ * UnoCSS 模块底层选项（用于 overrides）
+ */
+interface UnoCSSOptions {
+    presets?: unknown[];
+    rules?: unknown[];
+    shortcuts?: Record<string, string | string[]>;
+}
+/**
+ * 底层插件逃生口
+ *
+ * 高级用户可通过此字段直接覆盖底层插件选项，优先级最高。
+ * 90% 场景下不需要使用此字段，请优先使用上层融合约定。
+ */
+interface UnivaOverrides {
+    /** @uni-helper/vite-plugin-uni-pages 完整选项 */
+    pages?: UserOptions;
+    /** @uni-helper/vite-plugin-uni-layouts 完整选项 */
+    layouts?: LayoutsOptions;
+    /** @uni-helper/vite-plugin-uni-components 完整选项 */
+    components?: Options;
+    /** @uni-ku/root 完整选项 */
+    root?: RootOptions;
+    /** unplugin-auto-import 完整选项 */
+    autoImport?: Options$1;
+    /** unocss/vite 完整选项 */
+    unocss?: UnoCSSOptions;
+}
+/**
+ * Univa 统一配置接口（工程级约定）
+ *
+ * 用于 univa.config.ts，声明项目工程结构、自动导入约定与应用级配置。
+ */
 interface UnivaOptions {
-    autoImport?: boolean | Options;
-    components?: boolean | Options$1;
-    pages?: PagesOptions;
-    appRoot?: boolean;
-    manifest?: UserManifestConfig;
+    /** 源码目录，相对 Vite root，默认 'src' */
+    srcDir?: string;
+    /** 目录约定，相对 srcDir */
+    dirs?: UnivaDirs;
+    /** 自动导入配置 */
+    imports?: UnivaImports;
+    /**
+     * 应用级 pages.json 配置（globalStyle / tabBar 等）
+     *
+     * Univa 会读取此字段自动生成 .univa/pages.ts，
+     * 供 VitePluginUniPages 消费。
+     *
+     * 注意：pages / subPackages 由目录扫描自动填充，请勿在此手写。
+     */
+    pages?: Partial<PagesConfig>;
+    /** 底层插件逃生口（覆盖融合层默认，高级用户使用） */
+    overrides?: UnivaOverrides;
 }
-interface UnivaUserConfig extends UnivaOptions {
+/**
+ * 解析后的完整配置（内部使用）
+ *
+ * 与 UnivaOptions 的差异：srcDir/dirs/imports 为必填（已应用默认值）。
+ * 所有路径保持相对 Vite root 的格式，由底层插件自行解析。
+ */
+interface ResolvedOptions extends Omit<UnivaOptions, 'dirs' | 'imports' | 'srcDir'> {
+    /** 源码目录（已应用默认值，相对 Vite root） */
+    srcDir: string;
+    /** 目录约定（已应用默认值，字段必填） */
+    dirs: ResolvedUnivaDirs;
+    /** 自动导入配置（已应用默认值，字段必填） */
+    imports: ResolvedUnivaImports;
 }
 
-declare function definePagesConfig(config: DefinePagesConfig): DefinePagesConfig;
-
-declare function presetUniva(): Preset;
+/**
+ * 声明 Univa 工程级约定
+ *
+ * 用于 `univa.config.ts`，声明项目工程结构、自动导入约定与应用级配置。
+ */
+declare function defineConfig(config: UnivaOptions): UnivaOptions;
 
-declare function Univa(config?: UnivaUserConfig): PluginOption[];
+/**
+ * 创建所有 Univa 插件
+ *
+ * 从 resolved options 提取高层约定（dirs/imports），拼接 srcDir 前缀后传给底层插件，
+ * 合并 overrides（优先级最高）。全部模块默认启用。
+ *
+ * 所有路径均为相对 Vite root 的格式，由底层插件自行解析为绝对路径。
+ */
+declare function createUnivaPlugins(resolved: ResolvedOptions): PluginOption[];
+/**
+ * Univa 插件入口函数（零参数）
+ *
+ * 工程约定与应用配置通过 `univa.config.ts` 声明，
+ * `.univa/pages.ts` 等产物自动生成。
+ *
+ * @example
+ * // vite.config.ts
+ * import { Univa } from '@univa/core'
+ * export default defineConfig({
+ *   plugins: [...Univa()],
+ * })
+ */
+declare function Univa(): PluginOption[];
 
-export { Univa, type UnivaOptions, type UnivaUserConfig, definePagesConfig, presetUniva };
+export { type LayoutsOptions, type ResolvedOptions, type ResolvedUnivaDirs, type ResolvedUnivaImports, type RootOptions, Univa, type UnivaDirs, type UnivaImports, type UnivaOptions, type UnivaOverrides, type UnoCSSOptions, createUnivaPlugins, defineConfig };