@4399ywkf/core 4.0.85 → 5.0.0

package/dist/index.d.ts

@@ -1,6 +1,496 @@
-export * from './config/config';
-export * from './route/route';
-export { Generator, GeneratorType } from './service/generator';
-export * from './service/pluginAPI';
-export * from './service/service';
-export { Env, IAdd, IEvent, IModify, IRoute } from './types';
+import { G as GeneratorContext, b as PluginHooks, Y as YwkfConfig, c as PluginConfig, e as YwkfPlugin } from './schema-BuqmN_ra.js';
+export { B as BuildHooks, C as CodeInjection, D as DevServerConfig, E as EnvConfig, j as GeneratedFile, i as GeneratorHooks, H as HtmlConfig, M as MicroFrontendConfig, O as OutputConfig, P as PerformanceConfig, f as PluginContext, R as RouterConfig, g as RouterHooks, h as RuntimeHooks, S as StyleConfig, T as ToolsConfig, a as defaultConfig, d as defineConfig } from './schema-BuqmN_ra.js';
+export { createBaseConfig, createDevConfig, createProdConfig, createRspackConfig } from './rspack/index.js';
+export { ConventionalRouteGenerator, ConventionalRoutePlugin, ConventionalRoutePluginOptions, GeneratorOptions, RouteConfig, generateConventionalRoutes } from './router/index.js';
+import { Compiler } from '@rspack/core';
+export { a as AntdConfig, A as AppConfig, b as AppContextValue, L as LifecycleHooks, M as MicroAppConfig, P as ProviderConfig } from './types-BZV_2QtD.js';
+export { AppContext, AppContextProvider, ErrorBoundary, RootProvider, bootstrap, createMicroApp, createProvider, getMicroAppPublicPath, isMicroAppEnv, unmount, useApp, useAppName, useBasename, useEnv, useIsDev } from './runtime/index.js';
+export { PluginManager, createPlugin, definePlugin } from './plugin/index.js';
+import 'react';
+import 'react-router';
+import 'react/jsx-runtime';
+
+/**
+ * .ywkf 目录代码生成器
+ *
+ * 生成的文件：
+ * - index.tsx - 应用入口
+ * - routes.tsx - 约定式路由
+ * - bootstrap.tsx - 启动逻辑
+ * - types/routes.d.ts - 路由类型
+ * - types/env.d.ts - 环境变量类型
+ * - config.json - 配置快照
+ */
+declare class YwkfGenerator {
+    private context;
+    private pluginHooks;
+    private lastGeneratedContent;
+    constructor(context: Omit<GeneratorContext, "outputDir"> & {
+        outputDir?: string;
+    }, pluginHooks?: PluginHooks[]);
+    /**
+     * 生成所有文件
+     */
+    generate(): Promise<void>;
+    /**
+     * 生成配置快照
+     */
+    private generateConfigSnapshot;
+    /**
+     * 生成约定式路由
+     */
+    private generateRoutes;
+    /**
+     * 生成启动文件
+     */
+    private generateBootstrapFile;
+    /**
+     * 生成入口文件
+     */
+    private generateEntryFile;
+    /**
+     * 收集插件代码注入
+     */
+    private collectInjections;
+    /**
+     * 生成插件附加文件
+     */
+    private generatePluginFiles;
+    /**
+     * 生成类型定义
+     */
+    private generateTypes;
+    /**
+     * 确保目录存在
+     */
+    private ensureDir;
+    /**
+     * 只在内容变化时写入文件（避免触发不必要的热更新）
+     */
+    private writeFileIfChanged;
+    /**
+     * 标准化内容（去掉时间戳等动态部分）
+     */
+    private normalizeContent;
+}
+
+interface YwkfGeneratorPluginOptions {
+    /** 项目根目录 */
+    cwd: string;
+    /** 解析后的配置 */
+    config: Required<YwkfConfig>;
+    /** 输出目录（.ywkf） */
+    outputDir: string;
+    /** 是否开发模式 */
+    isDev: boolean;
+    /** 用户配置的插件列表（PluginConfig 格式） */
+    pluginConfigs?: PluginConfig[];
+}
+/**
+ * .ywkf 目录生成插件
+ *
+ * 在编译前生成 .ywkf 目录下的所有文件
+ */
+declare class YwkfGeneratorPlugin {
+    private options;
+    private hasGenerated;
+    private isWatching;
+    private generator;
+    private pluginHooks;
+    private initialized;
+    constructor(options: YwkfGeneratorPluginOptions);
+    /**
+     * 解析插件配置为插件实例
+     */
+    private resolvePlugin;
+    /**
+     * 初始化插件钩子
+     */
+    private initialize;
+    apply(compiler: Compiler): void;
+    /**
+     * 监听页面目录变化
+     */
+    private watchPages;
+}
+
+interface GarfishPluginOptions {
+    /** 应用名称（微前端标识） */
+    appName?: string;
+    /** 是否作为主应用 */
+    master?: boolean;
+    /** 子应用列表（主应用模式） */
+    apps?: {
+        name: string;
+        entry: string;
+        activeRule: string;
+        basename?: string;
+    }[];
+    /** 沙箱配置 */
+    sandbox?: {
+        /** 是否开启 JS 沙箱 */
+        open?: boolean;
+        /** 是否开启快照沙箱 */
+        snapshot?: boolean;
+        /** 样式隔离 */
+        strictStyleIsolation?: boolean;
+    };
+}
+/**
+ * Garfish 微前端插件
+ *
+ * 通过插件方式启用微前端功能，支持子应用和主应用两种模式。
+ *
+ * @example
+ * ```ts
+ * // ywkf.config.ts - 子应用模式
+ * import { defineConfig, garfishPlugin } from "@4399ywkf/core";
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     garfishPlugin({
+ *       appName: "sub-app",
+ *     }),
+ *   ],
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // ywkf.config.ts - 主应用模式
+ * import { defineConfig, garfishPlugin } from "@4399ywkf/core";
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     garfishPlugin({
+ *       master: true,
+ *       apps: [
+ *         { name: "sub-app", entry: "http://localhost:3001", activeRule: "/sub" },
+ *       ],
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+declare const garfishPlugin: (options?: GarfishPluginOptions | undefined) => YwkfPlugin;
+
+interface TailwindPluginOptions {
+    /**
+     * 自定义暗色模式选择器
+     * @default '&:where([data-theme="dark"], [data-theme="dark"] *)'
+     */
+    darkModeSelector?: string;
+    /**
+     * 是否生成 postcss.config.js（如果不存在）
+     * @default true
+     */
+    autoConfig?: boolean;
+    /**
+     * 额外的 CSS 内容（追加到 index.css 之后）
+     */
+    extraCSS?: string;
+}
+/**
+ * Tailwind CSS 插件
+ *
+ * 自动配置 Tailwind CSS：
+ * - 注入 `@import "tailwindcss"` 到 index.css
+ * - 确保 postcss.config.js 存在
+ * - 修改 Rspack 配置添加 postcss-loader
+ *
+ * @example
+ * ```ts
+ * import { defineConfig, tailwindPlugin } from "@4399ywkf/core";
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     tailwindPlugin(),
+ *   ],
+ * });
+ * ```
+ */
+declare const tailwindPlugin: (options?: TailwindPluginOptions | undefined) => YwkfPlugin;
+
+interface I18nPluginOptions {
+    /**
+     * 默认语言
+     * @default "zh-CN"
+     */
+    defaultLocale?: string;
+    /**
+     * 支持的语言列表
+     * @default ["zh-CN", "en-US"]
+     */
+    locales?: string[];
+    /**
+     * 翻译文件目录（相对于项目根目录）
+     * @default "locales"
+     */
+    localesDir?: string;
+    /**
+     * 默认命名空间
+     * @default ["common"]
+     */
+    defaultNS?: string[];
+    /**
+     * 是否自动生成初始翻译文件
+     * @default true
+     */
+    autoScaffold?: boolean;
+}
+/**
+ * 国际化插件
+ *
+ * 自动配置 i18next：
+ * - 生成 i18n 初始化代码到 .ywkf/i18n.ts
+ * - 注入 I18nextProvider 到启动文件
+ * - 自动生成初始翻译文件（可选）
+ *
+ * @example
+ * ```ts
+ * import { defineConfig, i18nPlugin } from "@4399ywkf/core";
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     i18nPlugin({
+ *       defaultLocale: "zh-CN",
+ *       locales: ["zh-CN", "en-US", "ja-JP"],
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+declare const i18nPlugin: (options?: I18nPluginOptions | undefined) => YwkfPlugin;
+
+interface ThemePluginOptions {
+    /**
+     * 是否启用暗色模式
+     * @default true
+     */
+    darkMode?: boolean;
+    /**
+     * 默认主题模式
+     * @default "auto"
+     */
+    defaultAppearance?: "light" | "dark" | "auto";
+    /**
+     * 主色调
+     * @default "blue"
+     */
+    primaryColor?: string;
+    /**
+     * antd 前缀
+     * @default "ant"
+     */
+    prefixCls?: string;
+    /**
+     * 是否启用 CSS 变量
+     * @default true
+     */
+    cssVar?: boolean;
+    /**
+     * 是否注入全局样式重置
+     * @default true
+     */
+    globalReset?: boolean;
+}
+/**
+ * 主题系统插件
+ *
+ * 基于 antd-style 提供主题管理能力：
+ * - 生成 ThemeProvider 包裹组件到 .ywkf/theme.tsx
+ * - 注入 ThemeProvider 到 bootstrap
+ * - 支持亮/暗色自动切换
+ *
+ * @example
+ * ```ts
+ * import { defineConfig, themePlugin } from "@4399ywkf/core";
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     themePlugin({
+ *       darkMode: true,
+ *       defaultAppearance: "auto",
+ *       primaryColor: "blue",
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+declare const themePlugin: (options?: ThemePluginOptions | undefined) => YwkfPlugin;
+
+interface MockPluginOptions {
+    /** Mock 文件目录 */
+    mockDir?: string;
+    /** 是否在生产环境启用 */
+    enableInProd?: boolean;
+    /** 延迟时间（模拟网络延迟） */
+    delay?: number;
+    /** 前缀路径 */
+    prefix?: string;
+}
+/**
+ * Mock 数据插件
+ *
+ * @example
+ * ```ts
+ * // ywkf.config.ts
+ * import { mockPlugin } from "@4399ywkf/core/plugin";
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     mockPlugin({
+ *       mockDir: "mock",
+ *       prefix: "/api",
+ *     }),
+ *   ],
+ * });
+ * ```
+ *
+ * Mock 文件示例 (mock/user.ts):
+ * ```ts
+ * export default {
+ *   "GET /api/users": [
+ *     { id: 1, name: "张三" },
+ *   ],
+ *   "POST /api/users": (req, res) => {
+ *     res.json({ success: true });
+ *   },
+ * };
+ * ```
+ */
+declare const mockPlugin: (options?: MockPluginOptions | undefined) => YwkfPlugin;
+
+interface AnalyticsPluginOptions {
+    /** 是否启用构建分析 */
+    buildAnalysis?: boolean;
+    /** 是否输出构建时间 */
+    timing?: boolean;
+    /** 是否分析 bundle 大小 */
+    bundleSize?: boolean;
+    /** 大文件警告阈值（KB） */
+    sizeWarningThreshold?: number;
+}
+/**
+ * 构建分析插件
+ *
+ * @example
+ * ```ts
+ * import { analyticsPlugin } from "@4399ywkf/core/plugin";
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     analyticsPlugin({
+ *       timing: true,
+ *       bundleSize: true,
+ *       sizeWarningThreshold: 500, // 500KB
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+declare const analyticsPlugin: (options?: AnalyticsPluginOptions | undefined) => YwkfPlugin;
+
+interface ReactQueryPluginOptions {
+    /**
+     * 默认 staleTime（毫秒）
+     * @default 5 * 60 * 1000 (5 分钟)
+     */
+    staleTime?: number;
+    /**
+     * 默认 gcTime（毫秒）
+     * @default 10 * 60 * 1000 (10 分钟)
+     */
+    gcTime?: number;
+    /**
+     * 默认重试次数
+     * @default 1
+     */
+    retry?: number | boolean;
+    /**
+     * 是否开启 React Query DevTools（仅开发模式生效）
+     * @default true
+     */
+    devtools?: boolean;
+    /**
+     * axios baseURL
+     * @default ""
+     */
+    baseURL?: string;
+    /**
+     * 请求超时时间（毫秒）
+     * @default 15000
+     */
+    timeout?: number;
+}
+/**
+ * React Query + Axios 请求层插件
+ *
+ * - 自动注入 QueryClientProvider
+ * - 生成 .ywkf/query-client.ts（QueryClient 实例 + 默认配置）
+ * - 生成 .ywkf/request.ts（axios 封装 + 拦截器骨架）
+ * - 开发模式可选开启 React Query DevTools
+ *
+ * @example
+ * ```ts
+ * import { defineConfig, reactQueryPlugin } from "@4399ywkf/core";
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     reactQueryPlugin({ staleTime: 5 * 60 * 1000 }),
+ *   ],
+ * });
+ * ```
+ */
+declare const reactQueryPlugin: (options?: ReactQueryPluginOptions | undefined) => YwkfPlugin;
+
+interface ZustandPluginOptions {
+    /**
+     * 是否自动生成 store 脚手架（仅在 store/ 目录不存在时）
+     * @default true
+     */
+    scaffold?: boolean;
+    /**
+     * store 目录路径（相对于项目根目录）
+     * @default "store"
+     */
+    storeDir?: string;
+}
+/**
+ * Zustand 状态管理插件
+ *
+ * 采用扁平域/Slice 架构：
+ * - store/{domain}/slices/ 按业务域拆分
+ * - 每个 slice 拆为 initialState.ts + actions.ts
+ * - 域级 store.ts 聚合所有 slice
+ * - 使用 StateCreator<Store, [['zustand/devtools', never]], [], Action> 标准范式
+ * - 内置 devtools + subscribeWithSelector 中间件
+ *
+ * @example
+ * ```ts
+ * import { defineConfig, zustandPlugin } from "@4399ywkf/core";
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     zustandPlugin(),
+ *   ],
+ * });
+ * ```
+ */
+declare const zustandPlugin: (options?: ZustandPluginOptions | undefined) => YwkfPlugin;
+
+/**
+ * 启动开发服务器
+ */
+declare function dev(options?: {
+    cwd?: string;
+}): Promise<void>;
+
+/**
+ * 执行生产构建
+ */
+declare function build(options?: {
+    cwd?: string;
+}): Promise<void>;
+
+export { type AnalyticsPluginOptions, type GarfishPluginOptions, GeneratorContext, type I18nPluginOptions, type MockPluginOptions, PluginConfig, PluginHooks, type ReactQueryPluginOptions, type TailwindPluginOptions, type ThemePluginOptions, YwkfConfig, YwkfGenerator, YwkfGeneratorPlugin, type YwkfGeneratorPluginOptions, YwkfPlugin, type ZustandPluginOptions, analyticsPlugin, build, dev, garfishPlugin, i18nPlugin, mockPlugin, reactQueryPlugin, tailwindPlugin, themePlugin, zustandPlugin };