@oj-module/runtime 0.1.5

package/dist/store/access.d.ts

@@ -0,0 +1,14 @@
+import type { MenuItemType } from "../layout/layout-menu/types";
+import type { AppRouteRecordRaw } from "../router/types";
+interface AccessState {
+    wholeMenus: MenuItemType[];
+    routeList: AppRouteRecordRaw[];
+    flatRouteList: Record<string, AppRouteRecordRaw>;
+    isAccessChecked: boolean;
+}
+interface AccessAction {
+    setAccessStore: (routes: AppRouteRecordRaw[]) => AccessState;
+    reset: () => void;
+}
+export declare const useAccessStore: import("zustand").UseBoundStore<import("zustand").StoreApi<AccessState & AccessAction>>;
+export {};

package/dist/store/api-provider.d.ts

@@ -0,0 +1,47 @@
+import type { MenuItemType } from "../api/system/menu/types";
+import type { FetchAddRoleItemBody, FetchAddRoleItemData, FetchDeleteRoleItemBody, FetchDeleteRoleItemData, FetchMenuByRoleIdData, FetchMenuByRoleIdQuery, FetchRoleListData, FetchRoleListQuery, FetchRoleMenuData, FetchUpdateRoleItemBody, FetchUpdateRoleItemData } from "../api/system/role/api/client";
+import type { NotificationItem } from "../layout/widgets/notification/types";
+/**
+ * 系统 API provider（D9）：模块经 ctx.register.systemApi 接管角色/菜单类
+ * 内置 API。系统角色/菜单/通知/上传这些原本硬编码在 runtime 根级路径的
+ * 内部端点，通过注册表可被模块注入为带自身 apiPrefix 的实现（如 playground
+ * 模块把 /system/* 收敛到其 /<dir> 前缀下），消费点（role/menu/notifications/
+ * 头像上传）在运行时委托，未注册时回落到内置 root 级实现（沿用既有 fetch*）。
+ *
+ * 三者全必填——「接管系统 API」是全量接管，不做部分托管（与 authProvider 同规则）。
+ * provider 对返回值自负责：runtime 在 provider 路径上不做任何成功/字段校验。
+ */
+export interface SystemApiProvider {
+    fetchRoleList: (query: FetchRoleListQuery) => Promise<FetchRoleListData>;
+    fetchAddRoleItem: (body: FetchAddRoleItemBody) => Promise<FetchAddRoleItemData>;
+    fetchUpdateRoleItem: (body: FetchUpdateRoleItemBody) => Promise<FetchUpdateRoleItemData>;
+    fetchDeleteRoleItem: (body: FetchDeleteRoleItemBody) => Promise<FetchDeleteRoleItemData>;
+    fetchRoleMenu: () => Promise<FetchRoleMenuData>;
+    fetchMenuByRoleId: (query: FetchMenuByRoleIdQuery) => Promise<FetchMenuByRoleIdData>;
+    fetchMenuList: (data: any) => Promise<ListData<MenuItemType>>;
+    fetchAddMenuItem: (data: MenuItemType) => Promise<string>;
+    fetchUpdateMenuItem: (data: MenuItemType) => Promise<string>;
+    fetchDeleteMenuItem: (id: number) => Promise<string>;
+}
+/** 通知 provider（D9）：模块经 ctx.register.notificationsApi 接管通知拉取 */
+export interface NotificationsApiProvider {
+    fetchNotifications: () => Promise<NotificationItem[]>;
+}
+/** 上传 provider（D9）：模块经 ctx.register.uploadApi 接管头像/附件上传端点 */
+export interface UploadApiProvider {
+    /** 上传 action URL */
+    action: string;
+    /** 每次上传动态取请求头（如注入 Bearer）；返回普通对象 */
+    headers: () => Record<string, string>;
+}
+export declare function registerSystemApiProvider(moduleName: string, provider: SystemApiProvider): void;
+export declare function getSystemApiProvider(): SystemApiProvider | undefined;
+export declare function registerNotificationsApiProvider(moduleName: string, provider: NotificationsApiProvider): void;
+export declare function getNotificationsApiProvider(): NotificationsApiProvider | undefined;
+export declare function registerUploadApiProvider(moduleName: string, provider: UploadApiProvider): void;
+export declare function getUploadApiProvider(): UploadApiProvider | undefined;
+/**
+ * 卸载模块时复位其登记的全部 API provider（系统/通知/上传）。以 moduleName
+ * 作命名隔离——不同模块各自登记互不干扰，卸载只清自己的。
+ */
+export declare function unregisterApiProviders(moduleName: string): void;

package/dist/store/auth-provider.d.ts

@@ -0,0 +1,19 @@
+import type { AuthType, LoginInfo, UserInfoType } from "../api/user/types";
+/**
+ * 认证 provider（P5）：模块经 ctx.register.authProvider 接管登录链路。
+ * 三者全必填——「接管认证」是全量接管，不做部分托管（半托管会让两条链路
+ * 并存、状态不可推理）。
+ *
+ * 契约边界（重要）：provider 对返回值自负责——runtime 在 provider 路径上
+ * 不做任何 success/字段校验，也不弹错误提示。login 返回的 Promise 必须
+ * 已归一为 AuthType（{ token, refreshToken }）；认证失败请直接 reject，
+ * runtime 会原样透传 rejection（错误提示归 provider 自己处理）。
+ */
+export interface AuthProvider {
+    login: (payload: LoginInfo) => Promise<AuthType>;
+    logout: () => Promise<void>;
+    getUserInfo: () => Promise<UserInfoType>;
+}
+export declare function registerAuthProvider(moduleName: string, provider: AuthProvider): void;
+export declare function getAuthProvider(): AuthProvider | undefined;
+export declare function unregisterAuthProvider(moduleName: string): void;

package/dist/store/auth.d.ts

@@ -0,0 +1,20 @@
+import type { AuthType, LoginInfo } from "../api/user/types";
+interface AuthAction {
+    login: (loginPayload: LoginInfo) => Promise<void>;
+    logout: () => Promise<void>;
+    reset: () => void;
+}
+export declare const useAuthStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<AuthType & AuthAction>, "setState" | "persist"> & {
+    setState(partial: (AuthType & AuthAction) | Partial<AuthType & AuthAction> | ((state: AuthType & AuthAction) => (AuthType & AuthAction) | Partial<AuthType & AuthAction>), replace?: false | undefined): unknown;
+    setState(state: (AuthType & AuthAction) | ((state: AuthType & AuthAction) => AuthType & AuthAction), replace: true): unknown;
+    persist: {
+        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<AuthType & AuthAction, AuthType & AuthAction, unknown>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => Promise<void> | void;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: AuthType & AuthAction) => void) => () => void;
+        onFinishHydration: (fn: (state: AuthType & AuthAction) => void) => () => void;
+        getOptions: () => Partial<import("zustand/middleware").PersistOptions<AuthType & AuthAction, AuthType & AuthAction, unknown>>;
+    };
+}>;
+export {};

package/dist/store/global.d.ts

@@ -0,0 +1,12 @@
+interface GlobalAction {
+    openGlobalSpin: () => void;
+    closeGlobalSpin: () => void;
+}
+export declare const useGlobalStore: import("zustand").UseBoundStore<import("zustand").StoreApi<{
+    /**
+     * @zh 全局加载动画是否显示
+     * @en Whether the global spinning animation is shown
+     */
+    globalSpin: boolean;
+} & GlobalAction>>;
+export {};

package/dist/store/preferences/index.d.ts

@@ -0,0 +1,80 @@
+import type { LanguageType } from "../../locales/index";
+import type { PreferencesState, ThemeType } from "./types";
+/**
+ * 默认偏好设置
+ */
+export declare const DEFAULT_PREFERENCES: {
+    watermark: false;
+    watermarkContent: string;
+    enableBackTopButton: true;
+    pageLayout: "layout-right";
+    enableBackendAccess: true;
+    enableFrontendAceess: false;
+    language: "zh-CN";
+    enableDynamicTitle: true;
+    enableCheckUpdates: true;
+    checkUpdatesInterval: number;
+    theme: "auto";
+    colorBlindMode: false;
+    colorGrayMode: false;
+    themeRadius: number;
+    builtinTheme: "blue";
+    themeColorPrimary: string;
+    transitionProgress: true;
+    transitionLoading: true;
+    transitionEnable: true;
+    transitionName: string;
+    navigationStyle: "side-navigation";
+    tabbarEnable: true;
+    tabbarShowIcon: true;
+    tabbarPersist: true;
+    tabbarDraggable: true;
+    tabbarStyleType: "chrome";
+    tabbarShowMore: true;
+    tabbarShowMaximize: true;
+    sidebarEnable: true;
+    sidebarWidth: number;
+    sideCollapsedWidth: number;
+    sidebarCollapsed: false;
+    sidebarCollapseShowTitle: true;
+    sidebarExtraCollapsedWidth: number;
+    firstColumnWidthInTwoColumnNavigation: number;
+    sidebarTheme: "light";
+    accordion: true;
+    enableFooter: true;
+    fixedFooter: true;
+    companyName: string;
+    companyWebsite: string;
+    copyrightDate: string;
+    ICPNumber: string;
+    ICPLink: string;
+};
+/**
+ * 偏好设置操作接口
+ */
+interface PreferencesAction {
+    reset: () => void;
+    changeSiteTheme: (theme: ThemeType) => void;
+    changeLanguage: (language: LanguageType) => void;
+    setPreferences: {
+        <T>(key: string, value: T): void;
+        <T extends Partial<PreferencesState>>(preferences: T): void;
+    };
+}
+/**
+ * 偏好设置状态管理
+ */
+export declare const usePreferencesStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<PreferencesState & PreferencesAction>, "setState" | "persist"> & {
+    setState(partial: (PreferencesState & PreferencesAction) | Partial<PreferencesState & PreferencesAction> | ((state: PreferencesState & PreferencesAction) => (PreferencesState & PreferencesAction) | Partial<PreferencesState & PreferencesAction>), replace?: false | undefined): unknown;
+    setState(state: (PreferencesState & PreferencesAction) | ((state: PreferencesState & PreferencesAction) => PreferencesState & PreferencesAction), replace: true): unknown;
+    persist: {
+        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<PreferencesState & PreferencesAction, PreferencesState & PreferencesAction, unknown>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => Promise<void> | void;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: PreferencesState & PreferencesAction) => void) => () => void;
+        onFinishHydration: (fn: (state: PreferencesState & PreferencesAction) => void) => () => void;
+        getOptions: () => Partial<import("zustand/middleware").PersistOptions<PreferencesState & PreferencesAction, PreferencesState & PreferencesAction, unknown>>;
+    };
+}>;
+export {};

package/dist/store/preferences/types.d.ts

@@ -0,0 +1,254 @@
+import type { MenuProps } from "antd";
+import type { MIXED_NAVIGATION, SIDE_NAVIGATION, TOP_NAVIGATION, TWO_COLUMN_NAVIGATION } from "../../layout/widgets/preferences/blocks/layout/constants";
+import type { LanguageType } from "../../locales/index";
+/**
+ * @zh 登录页面布局
+ * @en Login page layout
+ */
+export type PageLayoutType = "layout-left" | "layout-center" | "layout-right";
+/**
+ * @zh 标签栏风格
+ * @en Tabbar style
+ */
+export type TabsStyleType = "brisk" | "card" | "chrome" | "plain";
+/**
+ * @zh 主题类型
+ * @en Theme type
+ */
+export type ThemeType = "dark" | "light" | "auto";
+/**
+ * @zh 动画类型
+ * @en Animation type
+ */
+interface AnimationState {
+    /**
+     * @zh 是否启用过渡动画
+     * @en Whether to enable transition animation
+     * @default true
+     */
+    transitionProgress: boolean;
+    /**
+     * @zh 是否启用加载动画
+     * @en Whether to enable loading animation
+     * @default true
+     */
+    transitionLoading: boolean;
+    /**
+     * @zh 是否启用动画
+     * @en Whether to enable animation
+     * @default true
+     */
+    transitionEnable: boolean;
+    /**
+     * @zh 过渡动画名称
+     * @en Transition animation name
+     * @default "fade-slide"
+     */
+    transitionName: string;
+}
+export type NavigationType = typeof SIDE_NAVIGATION | typeof TOP_NAVIGATION | typeof TWO_COLUMN_NAVIGATION | typeof MIXED_NAVIGATION;
+export type BuiltinThemeType = "red" | "volcano" | "orange" | "gold" | "yellow" | "lime" | "green" | "cyan" | "blue" | "geekblue" | "purple" | "magenta" | "gray" | "custom";
+interface LayoutState {
+    navigationStyle: NavigationType;
+}
+export interface GeneralState {
+    /**
+     * @zh 是否开启水印
+     * @en Whether to enable watermark
+     * @default false
+     */
+    watermark: boolean;
+    /**
+     * @zh 水印内容
+     * @en Watermark content
+     * @default ""
+     */
+    watermarkContent: string;
+    /**
+     * @zh 返回页面顶部的操作按钮
+     * @en BackTop makes it easy to go back to the top of the page.
+     * @default true
+     */
+    enableBackTopButton: boolean;
+    /**
+     * @zh 登录页面的布局配置
+     * @en Login page layout configuration
+     * @default "layout-right"
+     */
+    pageLayout: PageLayoutType;
+    /**
+     * @zh 开启前端路由权限
+     * @en Enable frontend route permissions
+     * @default false
+     */
+    enableFrontendAceess: boolean;
+    /**
+     * @zh 开启后端路由权限
+     * @en Enable backend route permissions
+     * @default true
+     */
+    enableBackendAccess: boolean;
+    /**
+     * @zh 当前语言
+     * @en Current language
+     * @default "zh-CN"
+     */
+    language: LanguageType;
+    /**
+     * @zh 是否开启动态标题
+     * @en Whether to enable dynamic title
+     * @default true
+     */
+    enableDynamicTitle: boolean;
+    /**
+     * @zh 是否开启更新检查
+     * @en Whether to enable update check
+     * @default true
+     */
+    enableCheckUpdates: boolean;
+    /**
+     * @zh 轮训时间，单位：分钟，默认 1 分钟
+     * @en Polling time, unit: minute, default 1 minute
+     * @default 1
+     */
+    checkUpdatesInterval: number;
+}
+export interface SidebarState {
+    /**
+     * 侧边栏是否可见
+     * @default true
+     */
+    sidebarEnable?: boolean;
+    /**
+     * 侧边菜单宽度
+     * @default 210
+     */
+    sidebarWidth: number;
+    /**
+     * 侧边菜单折叠宽度
+     * @default 56
+     */
+    sideCollapsedWidth: number;
+    /**
+     * 侧边菜单折叠状态
+     * @default false
+     */
+    sidebarCollapsed: boolean;
+    /**
+     * 侧边菜单是否折叠时，是否显示 title
+     * @default true
+     */
+    sidebarCollapseShowTitle: boolean;
+    /**
+     * 侧边菜单折叠额外宽度
+     * @default 48
+     */
+    sidebarExtraCollapsedWidth: number;
+    /**
+     * 两栏布局时，左侧菜单宽度
+     * @default 80
+     */
+    firstColumnWidthInTwoColumnNavigation: number;
+    /**
+     * 侧边栏主题
+     * @default dark
+     */
+    sidebarTheme: MenuProps["theme"];
+    /**
+     * @zh 导航菜单手风琴模式
+     * @en Accordion mode of navigation menu
+     */
+    accordion: boolean;
+}
+export interface FooterState {
+    enableFooter: boolean;
+    fixedFooter: boolean;
+    companyName: string;
+    companyWebsite: string;
+    copyrightDate: string;
+    ICPNumber: string;
+    ICPLink: string;
+}
+export interface PreferencesState extends AnimationState, LayoutState, GeneralState, SidebarState, FooterState {
+    /**
+     * @zh 当前主题
+     * @en Current theme
+     * @default "auto"
+     */
+    theme: ThemeType;
+    /**
+     * @zh 是否开启色弱模式
+     * @en Whether to enable color-blind mode
+     * @default false
+     */
+    colorBlindMode: boolean;
+    /**
+     * @zh 是否开启灰色模式
+     * @en Whether to enable gray mode
+     * @default false
+     */
+    colorGrayMode: boolean;
+    /**
+     * @zh 主题圆角值
+     * @en Theme radius value
+     * @default 6
+     */
+    themeRadius: number;
+    /**
+     * @zh 主题色
+     * @en Theme color
+     * @default "#1677ff" - blue
+     */
+    themeColorPrimary: string;
+    /**
+     * @zh 内置主题
+     * @en Builtin theme
+     * @default "blue"
+     */
+    builtinTheme: BuiltinThemeType;
+    /**
+     * @zh 标签栏风格
+     * @en Tabbar style
+     * @default "chrome"
+     */
+    tabbarStyleType: TabsStyleType;
+    /**
+     * @zh 是否启用标签栏
+     * @en Whether to enable tabbar
+     * @default true
+     */
+    tabbarEnable: boolean;
+    /**
+     * @zh 是否显示标签栏图标
+     * @en Whether to show tabbar icon
+     * @default true
+     * @todo 待实现
+     */
+    tabbarShowIcon: boolean;
+    /**
+     * @zh 是否持久化标签栏
+     * @en Whether to persist tabbar
+     * @default true
+     */
+    tabbarPersist: boolean;
+    /**
+     * @zh 是否可拖拽标签栏
+     * @en Whether to drag tabbar
+     * @default true
+     * @todo 待实现
+     */
+    tabbarDraggable: boolean;
+    /**
+     * @zh 是否显示更多
+     * @en Whether to show more
+     * @default true
+     */
+    tabbarShowMore: boolean;
+    /**
+     * @zh 是否显示最大化
+     * @en Whether to show maximize
+     * @default true
+     */
+    tabbarShowMaximize: boolean;
+}
+export {};