@go-wind/admin-react 0.0.0-stage → 0.1.0

package/dist/transport/sse/sse_client.d.ts

@@ -0,0 +1,76 @@
+import type { SSEClientConfig, SSEConnectionStatus, SSEEventHandler, SSEEventName } from './types';
+/**
+ * SSE客户端
+ */
+export declare class SSEClient {
+    private abortController;
+    private config;
+    private eventSource;
+    private handlers;
+    private status;
+    private readonly transport;
+    constructor(config: SSEClientConfig);
+    /**
+     * 解析数据（自动处理 JSON 格式）
+     * @param rawData
+     * @private
+     */
+    private parseData;
+    /**
+     * 触发事件监听器
+     * @param eventName
+     * @param data
+     * @param event
+     * @private
+     */
+    private triggerHandler;
+    /**
+     * 通过 EventSource 建立 SSE 连接
+     * @param url 连接 URL
+     * @private
+     */
+    _connectByEventSource(url: string): void;
+    /**
+     * 通过 fetchEventSource 建立 SSE 连接（支持更灵活的配置和控制）
+     * @param url 连接 URL
+     * @private
+     */
+    _connectByFetchEventSource(url: string): Promise<void>;
+    /**
+     * 关闭 SSE 连接
+     */
+    close(): void;
+    /**
+     * 建立 SSE 连接
+     * @param url 可选连接 URL，默认为配置中的 URL
+     */
+    connect(url?: string): Error | null;
+    /**
+     * 获取当前连接状态
+     */
+    getStatus(): SSEConnectionStatus;
+    /**
+     * 移除事件监听器
+     * @param eventName
+     * @param handler
+     */
+    off<T = unknown>(eventName: SSEEventName, handler?: SSEEventHandler<T>): void;
+    /**
+     * 注册事件监听器（支持泛型指定数据类型）
+     * @param eventName
+     * @param handler
+     */
+    on<T = unknown>(eventName: SSEEventName, handler: SSEEventHandler<T>): void;
+    /**
+     * 关闭当前连接并使用新的 URL / headers 重新连接
+     * 适用于 token 刷新后需要携带新凭证的场景
+     * @param url 可选的新连接 URL，默认沿用配置中的 URL
+     */
+    reconnect(url?: string): void;
+    /**
+     * 动态设置/更新请求头（不会影响正在进行中的连接，下次 connect 时生效）
+     * 注意：EventSource 模式不支持自定义请求头，此方法仅对 fetch-event-source 模式生效
+     * @param headers 键值对，会浅合并到当前 headers 配置中
+     */
+    setHeaders(headers: Record<string, string>): void;
+}

package/dist/transport/sse/types.d.ts

@@ -0,0 +1,27 @@
+/**
+ * SSE 事件类型（区分默认事件和自定义事件）
+ */
+export type SSEEventName = 'error' | 'message' | 'open' | string;
+/**
+ * SSE 事件回调函数类型（T 为数据类型）
+ */
+export type SSEEventHandler<T = unknown> = (data: T, event: MessageEvent) => void;
+/**
+ * SSE 连接实现方式
+ */
+export type SSETransport = 'event-source' | 'fetch-event-source';
+/**
+ * SSE 客户端配置
+ */
+export interface SSEClientConfig {
+    url: string;
+    withCredentials?: boolean;
+    reconnectDelay?: number;
+    autoParseJson?: boolean;
+    headers?: Record<string, string>;
+    transport?: SSETransport;
+}
+/**
+ * SSE 连接状态
+ */
+export type SSEConnectionStatus = 'connected' | 'connecting' | 'disconnected' | 'error';

package/dist/types.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 包内基础类型（自 go-wind-admin 的 src/types/global.d.ts 迁入）。
+ *
+ * 宿主应用保留自己的全局 `UserInfo`/`BasicUserInfo` 声明即可——它们与本包的
+ * AdminUserInfo 结构兼容（宿主接口字段为必填，赋给本包可选字段类型天然可赋值），
+ * 无需 declaration merging。
+ */
+/** 用户信息基础形状（与宿主 BasicUserInfo 对齐） */
+export interface AdminUserBasic {
+    [key: string]: any;
+    /** 头像 */
+    avatar: string;
+    /** 用户id（后端 uint64，proto3 JSON 下为字符串） */
+    id: string;
+    /** 用户昵称 */
+    nickname: string;
+    /** 用户实名 */
+    realname: string;
+    /** 用户角色 */
+    roles?: string[];
+    /** 租户id（后端 uint64，proto3 JSON 下为字符串） */
+    tenantId: string;
+    /** 用户名 */
+    username: string;
+}
+/** 包内认证/用户 store 消费的用户信息形状 */
+export interface AdminUserInfo extends AdminUserBasic {
+    /** 用户描述 */
+    description?: string;
+    /** 首页地址 */
+    homePath?: string;
+    /** accessToken */
+    token?: string;
+}
+/**
+ * React Router 路由 handle 元数据类型。
+ * 用于 useMatches() 获取路由附加信息（自宿主全局声明迁入）。
+ */
+export interface RouteHandle {
+    title?: string;
+    icon?: string;
+    authority?: string[];
+    [key: string]: any;
+}

package/dist/utils/color.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 生成基于字符串的固定随机色（HSL模式，保证饱和度和明度适中）
+ *
+ * 浅底色（l=85）：只能配深色墨（最差色相对深色墨仍 ≥11:1），配白字不可读。
+ * @param str
+ */
+export declare const getRandomColor: (str: string) => string;
+/**
+ * 根据首字母生成固定随机色（头像实底色，前景固定近白）
+ *
+ * 明度取 28% 是量出来的：本函数的产物一律配 antd/EP 头像的白字，而 hsl 同饱和度下
+ * 45% 明度是"两种墨都不合格"的死区（360 个色相里最差 white 2.03 / dark 2.01）；
+ * 28% + s60 保证任意色相下白字 ≥4.86:1（判据与换算见 docs/design-language.md §2.1）。
+ * @param char
+ */
+export declare const getCharColor: (char: string) => string;
+export declare function hexToRgb(hex: string): [number, number, number];
+export declare function rgbToHex(r: number, g: number, b: number): string;
+/** 解析 `#rgb`/`#rrggbb`/`hsl(h s% l%)`/`hsl(h, s%, l%)` 为 [r,g,b]（0-255）；无法识别返回 null */
+export declare function parseColor(c: string): [number, number, number] | null;
+/**
+ * 与 CSS `color-mix(in srgb, base pct%, other)` 同口径的 JS 版本。
+ * 存在的理由：antd 的 token 值（colorLink、Menu.itemSelectedColor 等）会被 antd 再做
+ * 一次色彩运算，不能填 `var(--gowind-*)`，所以「语义色作文字」的降档/升档要在 TS 里算一遍；
+ * 比例与 vue-element 端 `styles/vendors/_element-plus.scss` §3 完全一致，改动须同步两处。
+ */
+export declare function mixColor(base: string, other: string, pct: number): string;

package/dist/utils/date.d.ts

@@ -0,0 +1,5 @@
+export declare function formatDate(dateString: string | undefined): string;
+export declare const formatDateTime: (timestamp?: any) => string;
+export declare const DATE_FORMAT = "YYYY-MM-DD";
+export declare const TIME_FORMAT = "YYYY-MM-DD HH:mm:ss";
+export declare const TIME_PICKER_FORMAT = "HH:mm:ss";

package/dist/utils/diff.d.ts

@@ -0,0 +1,6 @@
+declare function arraysEqual<T>(a: T[], b: T[]): boolean;
+type DiffResult<T> = Partial<{
+    [K in keyof T]: T[K] extends object ? DiffResult<T[K]> : T[K];
+}>;
+declare function diff<T extends Record<string, any>>(obj1: T, obj2: T): DiffResult<T>;
+export { arraysEqual, diff };

package/dist/utils/index.d.ts

@@ -0,0 +1,9 @@
+export * from './merge';
+export * from './inference';
+export * from './utils';
+export * from './nprogress';
+export * from './date';
+export * from './color';
+export * from './url';
+export * from './diff';
+export * from './tree';

package/dist/utils/inference.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 检查传入的值是否为函数。
+ *
+ * @param {unknown} value 要检查的值。
+ * @returns {boolean} 如果值是函数，返回 true，否则返回 false。
+ */
+declare function isFunction(value: unknown): value is (...args: unknown[]) => unknown;
+/**
+ * 检查传入的值是否为对象（不包括 null 和数组）。
+ *
+ * @param {unknown} value 要检查的值。
+ * @returns {boolean} 如果值是对象，返回 true，否则返回 false。
+ */
+declare function isObject(value: unknown): value is Record<string, unknown>;
+/**
+ * 检查传入的值是否为字符串。
+ *
+ * @param {unknown} value 要检查的值。
+ * @returns {boolean} 如果值是字符串，返回 true，否则返回 false。
+ */
+declare function isString(value: unknown): value is string;
+/**
+ * 检查传入的值是否为undefined。
+ *
+ * @param {unknown} value 要检查的值。
+ * @returns {boolean} 如果值是undefined，返回true，否则返回false。
+ */
+declare function isUndefined(value?: unknown): value is undefined;
+/**
+ * 检查传入的值是否为boolean
+ * @param value
+ * @returns 如果值是布尔值，返回true，否则返回false。
+ */
+declare function isBoolean(value: unknown): value is boolean;
+/**
+ * 检查传入的值是否为空。
+ *
+ * 以下情况将被认为是空：
+ * - 值为null。
+ * - 值为undefined。
+ * - 值为一个空字符串。
+ * - 值为一个长度为0的数组。
+ * - 值为一个没有元素的Map或Set。
+ * - 值为一个没有属性的对象。
+ *
+ * @param {T} value 要检查的值。
+ * @returns {boolean} 如果值为空，返回true，否则返回false。
+ */
+declare function isEmpty<T = unknown>(value?: T): value is T;
+/**
+ * 检查传入的字符串是否为有效的HTTP或HTTPS URL。
+ *
+ * @param {string} url 要检查的字符串。
+ * @return {boolean} 如果字符串是有效的HTTP或HTTPS URL，返回true，否则返回false。
+ */
+declare function isHttpUrl(url?: string): boolean;
+/**
+ * 检查传入的值是否为window对象。
+ *
+ * @param {unknown} value 要检查的值。
+ * @returns {boolean} 如果值是window对象，返回true，否则返回false。
+ */
+declare function isWindow(value: unknown): value is Window;
+/**
+ * 检查当前运行环境是否为Mac OS。
+ *
+ * 这个函数通过检查navigator.userAgent字符串来判断当前运行环境。
+ * 如果userAgent字符串中包含"macintosh"或"mac os x"（不区分大小写），则认为当前环境是Mac OS。
+ *
+ * @returns {boolean} 如果当前环境是Mac OS，返回true，否则返回false。
+ */
+declare function isMacOs(): boolean;
+/**
+ * 检查当前运行环境是否为Windows OS。
+ *
+ * 这个函数通过检查navigator.userAgent字符串来判断当前运行环境。
+ * 如果userAgent字符串中包含"windows"或"win32"（不区分大小写），则认为当前环境是Windows OS。
+ *
+ * @returns {boolean} 如果当前环境是Windows OS，返回true，否则返回false。
+ */
+declare function isWindowsOs(): boolean;
+/**
+ * 检查传入的值是否为数字
+ * @param value
+ */
+declare function isNumber(value: unknown): value is number;
+/**
+ * Returns the first value in the provided list that is neither `null` nor `undefined`.
+ *
+ * This function iterates over the input values and returns the first one that is
+ * not strictly equal to `null` or `undefined`. If all values are either `null` or
+ * `undefined`, it returns `undefined`.
+ *
+ * @template T - The type of the input values.
+ * @param {...(T | null | undefined)[]} values - A list of values to evaluate.
+ * @returns {T | undefined} - The first value that is not `null` or `undefined`, or `undefined` if none are found.
+ *
+ * @example
+ * // Returns 42 because it is the first non-null, non-undefined value.
+ * getFirstNonNullOrUndefined(undefined, null, 42, 'hello'); // 42
+ *
+ * @example
+ * // Returns 'hello' because it is the first non-null, non-undefined value.
+ * getFirstNonNullOrUndefined(null, undefined, 'hello', 123); // 'hello'
+ *
+ * @example
+ * // Returns undefined because all values are either null or undefined.
+ * getFirstNonNullOrUndefined(undefined, null); // undefined
+ */
+declare function getFirstNonNullOrUndefined<T>(...values: (null | T | undefined)[]): T | undefined;
+export { getFirstNonNullOrUndefined, isBoolean, isEmpty, isFunction, isHttpUrl, isMacOs, isNumber, isObject, isString, isUndefined, isWindow, isWindowsOs, };

package/dist/utils/merge.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 深度合并对象
+ * @param target - 目标对象
+ * @param source - 源对象
+ * @returns 合并后的新对象
+ */
+export declare function merge<T extends Record<string, any>, U extends Record<string, any>>(target: T, source: U): T & U;
+/**
+ * 创建自定义合并函数
+ * @param customizer - 自定义处理函数
+ * @returns 合并函数
+ */
+export declare function createMerge(customizer?: (obj: Record<string, any>, key: string, value: any) => boolean | void): <T extends Record<string, any>, U extends Record<string, any>>(target: T, source: U) => T & U;
+/**
+ * 带数组覆盖功能的合并函数
+ */
+export declare const mergeWithArrayOverride: <T extends Record<string, any>, U extends Record<string, any>>(target: T, source: U) => T & U;

package/dist/utils/nprogress.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 开始显示进度条。
+ * 此函数首先加载NProgress库，然后调用NProgress的start方法开始显示进度条。
+ */
+declare function startProgress(): Promise<void>;
+/**
+ * 停止显示进度条，并隐藏进度条。
+ * 此函数首先加载NProgress库，然后调用NProgress的done方法停止并隐藏进度条。
+ */
+declare function stopProgress(): Promise<void>;
+export { startProgress, stopProgress };

package/dist/utils/tree.d.ts

@@ -0,0 +1,27 @@
+interface TreeConfigOptions {
+    childProps: string;
+}
+/**
+ * @zh_CN 遍历树形结构，并返回所有节点中指定的值。
+ * @param tree 树形结构数组
+ * @param getValue 获取节点值的函数
+ * @param options 作为子节点数组的可选属性名称。
+ * @returns 所有节点中指定的值的数组
+ */
+declare function traverseTreeValues<T, V>(tree: T[], getValue: (node: T) => V, options?: TreeConfigOptions): V[];
+/**
+ * 根据条件过滤给定树结构的节点，并以原有顺序返回所有匹配节点的数组。
+ * @param tree 要过滤的树结构的根节点数组。
+ * @param filter 用于匹配每个节点的条件。
+ * @param options 作为子节点数组的可选属性名称。
+ * @returns 包含所有匹配节点的数组。
+ */
+declare function filterTree<T extends Record<string, any>>(tree: T[], filter: (node: T) => boolean, options?: TreeConfigOptions): T[];
+/**
+ * 根据条件重新映射给定树结构的节
+ * @param tree 要过滤的树结构的根节点数组。
+ * @param mapper 用于map每个节点的条件。
+ * @param options 作为子节点数组的可选属性名称。
+ */
+declare function mapTree<T, V extends Record<string, any>>(tree: T[], mapper: (node: T) => V, options?: TreeConfigOptions): V[];
+export { filterTree, mapTree, traverseTreeValues };

package/dist/utils/url.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 获取url中的全部参数
+ * @param search - url参数
+ */
+export declare function getUrlAllParam(search: string): Record<string, string>;
+/**
+ * 获取url中参数某个值
+ * @param search - url参数
+ * @param key - 搜索值
+ */
+export declare function getUrlParam(search: string, key: string): string;

package/dist/utils/utils.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Sums the passed percentage to the R, G or B of a HEX color
+ * @param {string} color The color to change
+ * @param {number} amount The amount to change the color by
+ * @returns {string} The processed part of the color
+ */
+export declare function addLight(color: string, amount: number): string;
+/**
+ * Lightens a 6 char HEX color according to the passed percentage
+ * @param {string} color The color to change
+ * @param {number} amount The amount to change the color by
+ * @returns {string} The processed color represented as HEX
+ */
+export declare function lighten(color: string, amount: number): string;
+/**
+ * 绑定实例方法
+ * @param instance 实例
+ */
+export declare function bindMethods<T extends object>(instance: T): void;
+/**
+ * 滚动到顶部
+ */
+export declare function scrollToTop(): void;
+/**
+ * 滚动到底部
+ */
+export declare function scrollToBottom(): void;
+/**
+ * 滚动到指定元素
+ * @param element 目标元素
+ */
+export declare function scrollTo(element: HTMLElement): void;
+/**
+ * 金额格式化3000->3,000
+ * @param amount - 金额
+ */
+export declare function amountFormatter(amount: number): string;

package/package.json

@@ -1,6 +1,73 @@
 {
   "name": "@go-wind/admin-react",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "React 19 admin shell mechanisms extracted from go-wind-admin: axios transport (token rotation/captcha headers), SSE client, auth store with injectable AuthGateway, route factory (frontend/backend access modes), access control, i18n engine, theme/preferences, query client, generic hooks & utils.",
+  "type": "module",
+  "license": "MIT",
+  "keywords": [
+    "react",
+    "admin",
+    "auth",
+    "router",
+    "i18n",
+    "theme",
+    "antd"
+  ],
+  "files": [
+    "dist"
+  ],
+  "module": "./dist/admin-react.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/admin-react.js"
+    },
+    "./style.css": "./dist/admin-react.css"
+  },
+  "peerDependencies": {
+    "@ant-design/icons": ">=5.6.0",
+    "@ant-design/pro-components": ">=2.8.0",
+    "@tanstack/react-query": ">=5.0.0",
+    "antd": ">=6.0.0",
+    "i18next": ">=25.0.0",
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0",
+    "react-i18next": ">=17.0.0",
+    "react-router-dom": ">=6.26.0",
+    "zustand": ">=5.0.0"
+  },
+  "dependencies": {
+    "@microsoft/fetch-event-source": "^2.0.1",
+    "axios": "^1.16.1",
+    "dayjs": "^1.11.20",
+    "nprogress": "^0.2.0"
+  },
+  "devDependencies": {
+    "@ant-design/icons": "^5.6.1",
+    "@ant-design/pro-components": "^2.8.10",
+    "@tanstack/react-query": "^5.100.11",
+    "@types/nprogress": "^0.2.3",
+    "@types/react": "^19.2.15",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^5.1.2",
+    "antd": "^6.4.3",
+    "i18next": "^26.2.0",
+    "less": "^4.6.4",
+    "react": "^19.2.6",
+    "react-dom": "^19.2.6",
+    "react-i18next": "^17.0.8",
+    "react-router-dom": "^6.26.0",
+    "typescript": "^5.9.3",
+    "vite": "^8.0.0",
+    "zustand": "^5.0.13"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.build.json && node ../../scripts/flatten-dts.mjs",
+    "typecheck": "tsc --noEmit"
+  }
 }