@pawover/kit 0.4.1 → 0.5.1

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/pawover"
   },
   "description": "一个基于 TypeScript 的开发工具包",
-  "version": "0.4.1",
+  "version": "0.5.1",
   "type": "module",
   "engines": {
     "node": ">=22.20.0"
@@ -14,7 +14,7 @@
   "devEngines": {
     "runtime": {
       "name": "node",
-      "version": "24.14.0"
+      "version": "24.18.0"
     }
   },
   "keywords": [
@@ -27,7 +27,7 @@
     "url": "git+https://github.com/pawover/pawover-kit.git"
   },
   "license": "MIT",
-  "main": "./packages/utils/dist/index.js",
+  "main": "./packages/utils/dist/index.cjs",
   "module": "./packages/utils/dist/index.js",
   "types": "./packages/utils/dist/index.d.ts",
   "files": [
@@ -36,48 +36,152 @@
     "packages/zod/dist"
   ],
   "exports": {
-    ".": "./packages/utils/dist/index.js",
-    "./math": "./packages/utils/dist/math.js",
-    "./vite": "./packages/utils/dist/vite.js",
+    ".": {
+      "import": {
+        "types": "./packages/utils/dist/index.d.ts",
+        "default": "./packages/utils/dist/index.js"
+      },
+      "require": {
+        "types": "./packages/utils/dist/index.d.cts",
+        "default": "./packages/utils/dist/index.cjs"
+      }
+    },
+    "./math": {
+      "import": {
+        "types": "./packages/utils/dist/math.d.ts",
+        "default": "./packages/utils/dist/math.js"
+      },
+      "require": {
+        "types": "./packages/utils/dist/math.d.cts",
+        "default": "./packages/utils/dist/math.cjs"
+      }
+    },
+    "./vite": {
+      "import": {
+        "types": "./packages/utils/dist/vite.d.ts",
+        "default": "./packages/utils/dist/vite.js"
+      },
+      "require": {
+        "types": "./packages/utils/dist/vite.d.cts",
+        "default": "./packages/utils/dist/vite.cjs"
+      }
+    },
     "./metadata.json": "./packages/utils/dist/metadata.json",
-    "./utils": "./packages/utils/dist/index.js",
-    "./utils/math": "./packages/utils/dist/math.js",
-    "./utils/vite": "./packages/utils/dist/vite.js",
-    "./utils/*": "./packages/utils/dist/*",
-    "./hooks/alova": "./packages/hooks/dist/alova.js",
-    "./hooks/react": "./packages/hooks/dist/react.js",
-    "./hooks/*": "./packages/hooks/dist/*",
-    "./zod": "./packages/zod/dist/index.js",
-    "./zod/*": "./packages/zod/dist/*"
+    "./utils": {
+      "import": {
+        "types": "./packages/utils/dist/index.d.ts",
+        "default": "./packages/utils/dist/index.js"
+      },
+      "require": {
+        "types": "./packages/utils/dist/index.d.cts",
+        "default": "./packages/utils/dist/index.cjs"
+      }
+    },
+    "./utils/math": {
+      "import": {
+        "types": "./packages/utils/dist/math.d.ts",
+        "default": "./packages/utils/dist/math.js"
+      },
+      "require": {
+        "types": "./packages/utils/dist/math.d.cts",
+        "default": "./packages/utils/dist/math.cjs"
+      }
+    },
+    "./utils/vite": {
+      "import": {
+        "types": "./packages/utils/dist/vite.d.ts",
+        "default": "./packages/utils/dist/vite.js"
+      },
+      "require": {
+        "types": "./packages/utils/dist/vite.d.cts",
+        "default": "./packages/utils/dist/vite.cjs"
+      }
+    },
+    "./utils/*": {
+      "import": {
+        "types": "./packages/utils/dist/*",
+        "default": "./packages/utils/dist/*"
+      },
+      "require": "./packages/utils/dist/*"
+    },
+    "./hooks/alova": {
+      "import": {
+        "types": "./packages/hooks/dist/alova.d.ts",
+        "default": "./packages/hooks/dist/alova.js"
+      },
+      "require": {
+        "types": "./packages/hooks/dist/alova.d.cts",
+        "default": "./packages/hooks/dist/alova.cjs"
+      }
+    },
+    "./hooks/react": {
+      "import": {
+        "types": "./packages/hooks/dist/react.d.ts",
+        "default": "./packages/hooks/dist/react.js"
+      },
+      "require": {
+        "types": "./packages/hooks/dist/react.d.cts",
+        "default": "./packages/hooks/dist/react.cjs"
+      }
+    },
+    "./hooks/*": {
+      "import": {
+        "types": "./packages/hooks/dist/*",
+        "default": "./packages/hooks/dist/*"
+      },
+      "require": "./packages/hooks/dist/*"
+    },
+    "./zod": {
+      "import": {
+        "types": "./packages/zod/dist/index.d.ts",
+        "default": "./packages/zod/dist/index.js"
+      },
+      "require": {
+        "types": "./packages/zod/dist/index.d.cts",
+        "default": "./packages/zod/dist/index.cjs"
+      }
+    },
+    "./zod/*": {
+      "import": {
+        "types": "./packages/zod/dist/*",
+        "default": "./packages/zod/dist/*"
+      },
+      "require": "./packages/zod/dist/*"
+    }
   },
   "devDependencies": {
     "@commitlint/cli": "^21.2.1",
     "@commitlint/config-conventional": "^21.2.0",
-    "@eslint-react/eslint-plugin": "^5.17.3",
+    "@eslint-react/eslint-plugin": "^5.18.2",
     "@pawover/eslint-rules": "^0.2.3",
-    "@playwright/test": "^1.61.1",
+    "@playwright/test": "^1.62.1",
     "@stylistic/eslint-plugin": "^6.0.0-beta.5",
+    "@testing-library/react": "^16.3.2",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^26.1.1",
-    "@vitejs/plugin-react": "^6.0.4",
+    "@types/node": "^26.1.2",
+    "@types/react": "^19.2.18",
+    "@vitejs/plugin-react": "^6.0.5",
     "@vitest/browser-playwright": "^4.1.10",
+    "@vitest/coverage-v8": "^4.1.10",
+    "alova": "^3.5.1",
     "commitizen": "^4.3.2",
     "cz-customizable": "^7.5.4",
-    "eslint": "^10.7.0",
+    "eslint": "^10.8.0",
     "eslint-plugin-antfu": "^3.2.3",
     "eslint-plugin-import-lite": "^0.6.0",
     "eslint-plugin-react-hooks": "^7.1.1",
-    "fs-extra": "^11.3.6",
+    "fs-extra": "^11.4.0",
     "husky": "^9.1.7",
-    "jsdom": "^29.1.1",
-    "lint-staged": "^17.1.1",
+    "jsdom": "^30.0.1",
+    "lint-staged": "^17.3.0",
+    "mathjs": "^15.2.0",
     "prettier": "^3.9.6",
+    "react-dom": "19.2.6",
     "rimraf": "^6.1.3",
-    "taze": "^19.16.0",
-    "tsdown": "^0.22.13",
-    "turbo": "^2.10.5",
+    "tsdown": "^0.22.14",
+    "turbo": "^2.10.8",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.65.0",
+    "typescript-eslint": "^8.66.0",
     "vitest": "^4.1.10"
   },
   "peerDependencies": {
@@ -113,7 +217,14 @@
     }
   },
   "scripts": {
-    "test": "vitest",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:unit": "vitest run test/unit",
+    "test:integration": "vitest run test/integration",
+    "test:types": "tsc -p test/tsconfig.json --noEmit",
+    "test:smoke": "node test/scripts/smoke.mjs",
+    "test:ci": "pnpm test:types && pnpm test && pnpm build && pnpm test:smoke && pnpm check:pack",
     "build": "turbo build",
     "build:force": "turbo build --force",
     "build:package": "turbo build:package && pnpm package",
@@ -124,13 +235,13 @@
     "check:types": "tsc --noEmit",
     "check:eslint": "eslint --fix \"**/*.{js,cjs,mjs,ts,cts,mts,jsx,tsx,vue}\" --cache-location=.cache/eslint.cache.json --cache",
     "check:format": "prettier --write \"**/*.{html,json,jsonc}\" --cache-location=.cache/prettier.cache.json --cache",
-    "check:pack": "attw --pack .",
+    "check:pack": "pnpm dlx @arethetypeswrong/cli --pack . --profile node16",
     "clean": "pnpm clean:cache & pnpm clean:lib & pnpm clean:output",
     "clean:turbo": "rimraf -g **/.turbo",
     "clean:cache": "rimraf -g .cache",
     "clean:lib": "rimraf -g node_modules",
     "clean:output": "rimraf -g **/dist **/*.tgz",
-    "lib:up": "taze -I -r --exclude pnpm",
+    "lib:up": "pnpm dlx taze -I -r --exclude pnpm",
     "commit": "git cz"
   }
 }

package/packages/hooks/dist/alova.cjs

@@ -0,0 +1,53 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let alova_client = require("alova/client");
+//#region src/alova/createBeforeRequestMiddleware.ts
+function createBeforeRequestMiddleware(middleware, onBeforeRequest) {
+	return async (context, next) => {
+		onBeforeRequest?.(context);
+		if (middleware) return middleware(context, next);
+		return next();
+	};
+}
+//#endregion
+//#region src/alova/useAlovaPagination.ts
+function useAlovaPagination(methodHandler, hookOptions) {
+	const options = {
+		...hookOptions,
+		immediate: hookOptions?.immediate ?? true
+	};
+	if (options.onBeforeRequest) options.middleware = createBeforeRequestMiddleware(options.middleware, options.onBeforeRequest);
+	const exposure = (0, alova_client.usePagination)(methodHandler, options);
+	if (options.onSuccess) exposure.onSuccess(options.onSuccess);
+	if (options.onError) exposure.onError(options.onError);
+	if (options.onComplete) exposure.onComplete(options.onComplete);
+	return exposure;
+}
+//#endregion
+//#region src/alova/useAlovaRequest.ts
+function useAlovaRequest(methodHandler, hookOptions) {
+	const options = {
+		...hookOptions,
+		immediate: hookOptions?.immediate ?? true
+	};
+	if (options.onBeforeRequest) options.middleware = createBeforeRequestMiddleware(options.middleware, options.onBeforeRequest);
+	const exposure = (0, alova_client.useRequest)(methodHandler, options);
+	if (options.onSuccess) exposure.onSuccess(options.onSuccess);
+	if (options.onError) exposure.onError(options.onError);
+	if (options.onComplete) exposure.onComplete(options.onComplete);
+	return exposure;
+}
+//#endregion
+//#region src/alova/useAlovaWatcher.ts
+function useAlovaWatcher(methodHandler, watchingStates, hookOptions = {}) {
+	const options = { ...hookOptions };
+	if (options.onBeforeRequest) options.middleware = createBeforeRequestMiddleware(options.middleware, options.onBeforeRequest);
+	const exposure = (0, alova_client.useWatcher)(methodHandler, watchingStates, options);
+	if (options.onSuccess) exposure.onSuccess(options.onSuccess);
+	if (options.onError) exposure.onError(options.onError);
+	if (options.onComplete) exposure.onComplete(options.onComplete);
+	return exposure;
+}
+//#endregion
+exports.useAlovaPagination = useAlovaPagination;
+exports.useAlovaRequest = useAlovaRequest;
+exports.useAlovaWatcher = useAlovaWatcher;

package/packages/hooks/dist/alova.d.cts

@@ -0,0 +1 @@
+export type * from './alova.d.ts'

package/packages/hooks/dist/index.d.cts

@@ -0,0 +1 @@
+export type * from './index.d.ts'

package/packages/hooks/dist/react.cjs

@@ -0,0 +1,169 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let react = require("react");
+let _pawover_kit_utils = require("@pawover/kit-utils");
+let es_toolkit = require("es-toolkit");
+//#region src/react/useLatest.ts
+/**
+* 返回当前最新值的 Hook
+*
+* @param value
+*/
+function useLatest(value) {
+	const ref = (0, react.useRef)(value);
+	ref.current = value;
+	return ref;
+}
+//#endregion
+//#region src/react/useMount.ts
+/**
+* 在组件初始化时执行的 Hook
+* - 即使在严格模式（React StrictMode）也只执行一次
+* - 自动使用最新版 effect 函数
+*
+* @param effect 副作用函数（必须为同步函数；若为异步函数，清理逻辑需自行处理）
+* @example
+* useMount(() => {
+*   console.log('组件挂载');
+*   return () => console.log('组件卸载');
+* });
+*
+* useMount(async () => {
+*   const data = await fetchData();
+*   // 清理逻辑需通过 ref/AbortController 自行管理
+*   // ❌ 不要 return cleanupFn（async 函数返回 Promise，无法作为清理函数）
+* });
+*/
+function useMount(effect) {
+	const isMountedRef = (0, react.useRef)(false);
+	const effectRef = useLatest(effect);
+	(0, react.useEffect)(() => {
+		if (!_pawover_kit_utils.TypeUtil.isFunction(effectRef.current)) {
+			console.error(`hook [useMount] Expected parameter to be a function, but got ${typeof effectRef.current}. This effect will not execute.`);
+			return;
+		}
+		if (isMountedRef.current) return;
+		isMountedRef.current = true;
+		const cleanup = effectRef.current?.();
+		return _pawover_kit_utils.TypeUtil.isFunction(cleanup) && !_pawover_kit_utils.TypeUtil.isPromise(cleanup) ? cleanup : void 0;
+	}, [effectRef]);
+}
+//#endregion
+//#region src/react/useResponsive.ts
+/** 屏幕响应断点 token 配置 */
+const BREAK_POINT_TOKEN = {
+	XS: 480,
+	XSMax: 575,
+	XSMin: 480,
+	SM: 576,
+	SMMax: 767,
+	SMMin: 576,
+	MD: 768,
+	MDMax: 991,
+	MDMin: 768,
+	LG: 992,
+	LGMax: 1199,
+	LGMin: 992,
+	XL: 1200,
+	XLMax: 1599,
+	XLMin: 1200,
+	XXL: 1600,
+	XXLMax: 1919,
+	XXLMin: 1600,
+	XXXL: 1920,
+	XXXLMin: 1920
+};
+const SUBSCRIBER_SET = /* @__PURE__ */ new Set();
+const BREAK_POINTS = [
+	"xxxl",
+	"xxl",
+	"xl",
+	"lg",
+	"md",
+	"sm",
+	"xs"
+];
+const DEFAULT_VALUES = Object.freeze(_pawover_kit_utils.ArrayUtil.zipToObject(BREAK_POINTS, false));
+let responsiveValues = { ...DEFAULT_VALUES };
+let responsiveTokens = (0, es_toolkit.clone)(BREAK_POINT_TOKEN);
+function useResponsive(options) {
+	const { breakPointTokens = {} } = options || {};
+	const tokens = (0, react.useMemo)(() => Object.assign(BREAK_POINT_TOKEN, breakPointTokens), [breakPointTokens]);
+	const [responsive, setResponsive] = (0, react.useState)(() => calculateResponsive(tokens));
+	const current = _pawover_kit_utils.ObjectUtil.keys(DEFAULT_VALUES).find((key) => responsive[key] === true) || "xs";
+	(0, react.useLayoutEffect)(() => {
+		responsiveTokens = tokens;
+		window.addEventListener("resize", resizeListener);
+		const subscriber = () => {
+			setResponsive(responsiveValues);
+		};
+		SUBSCRIBER_SET.add(subscriber);
+		return () => {
+			SUBSCRIBER_SET.delete(subscriber);
+			if (!SUBSCRIBER_SET.size) window.removeEventListener("resize", resizeListener);
+		};
+	}, [tokens]);
+	return {
+		responsive,
+		current,
+		breakPointTokens: tokens
+	};
+}
+function resizeListener() {
+	const newValues = calculateResponsive(responsiveTokens);
+	if (!(0, es_toolkit.isEqual)(responsiveValues, newValues)) {
+		responsiveValues = newValues;
+		for (const subscriber of SUBSCRIBER_SET) subscriber();
+	}
+}
+function calculateResponsive(tokens) {
+	const config = _pawover_kit_utils.ArrayUtil.zipToObject(BREAK_POINTS, BREAK_POINTS.map((t) => tokens[_pawover_kit_utils.StringUtil.toUpperCase(t)]));
+	return _pawover_kit_utils.ObjectUtil.entriesMap(DEFAULT_VALUES, (key) => [key, window.innerWidth >= config[key]]);
+}
+//#endregion
+//#region src/react/useUnmount.ts
+/**
+* 在组件卸载时执行的 Hook
+*
+* @param effect 副作用函数
+*/
+function useUnmount(effect) {
+	const effectRef = useLatest(effect);
+	(0, react.useEffect)(() => () => {
+		if (!_pawover_kit_utils.TypeUtil.isFunction(effectRef.current)) {
+			console.error(`hook [useUnmount] Expected parameter to be a function, but got ${typeof effectRef.current}. This effect will not execute.`);
+			return;
+		}
+		effectRef.current?.();
+	}, [effectRef]);
+}
+//#endregion
+//#region src/react/useTitle.ts
+/**
+* 设置页面标题
+* - 轻量级，适用于无路由库时设置页面标题
+* - 多个 `useTitle` 实例会互相干扰，需在顶层组件使用
+* - 无法处理 `document.title` 固有的竞态问题
+*
+* @param title 页面标题
+* @param options 配置选项
+*/
+function useTitle(title, options) {
+	const titleRef = (0, react.useRef)(_pawover_kit_utils.EnvUtil.isBrowser() ? document.title : "");
+	(0, react.useEffect)(() => {
+		if (!_pawover_kit_utils.TypeUtil.isString(title)) {
+			console.error(`hook [useTitle] Expected parameter to be a string, but got ${typeof title}. This effect will not execute.`);
+			return;
+		}
+		if (_pawover_kit_utils.EnvUtil.isBrowser()) document.title = title;
+	}, [title]);
+	useUnmount(() => {
+		if (_pawover_kit_utils.EnvUtil.isBrowser() && options?.isRestoreOnUnmount) document.title = titleRef.current;
+	});
+}
+//#endregion
+exports.BREAK_POINT_TOKEN = BREAK_POINT_TOKEN;
+exports.useLatest = useLatest;
+exports.useMount = useMount;
+exports.useResponsive = useResponsive;
+exports.useTitle = useTitle;
+exports.useUnmount = useUnmount;

package/packages/hooks/dist/react.d.cts

@@ -0,0 +1 @@
+export type * from './react.d.ts'

package/packages/hooks/dist/react.d.ts

@@ -1,4 +1,6 @@
 import { EffectCallback, RefObject } from "react";
+import { AnyAsyncFunction, AnyFunction } from "@pawover/types";
+import { TupleToUnion } from "type-fest";
 //#region src/react/useLatest.d.ts
 /**
  * 返回当前最新值的 Hook
@@ -7,12 +9,6 @@ import { EffectCallback, RefObject } from "react";
  */
 declare function useLatest<T>(value: T): RefObject<T>;
 //#endregion
-//#region ../../node_modules/.pnpm/@pawover+types@0.0.4_@types+react@19.2.15_typescript@6.0.3/node_modules/@pawover/types/dist/index.d.ts
-/** 描述函数类型 */
-type AnyFunction<P extends any[] = any[], R = any> = (...arg: P) => R;
-/** 描述异步函数类型 */
-type AnyAsyncFunction<P extends any[] = any[], R = any> = (...args: P) => Promise<R>;
-//#endregion
 //#region src/react/useMount.d.ts
 /**
  * 在组件初始化时执行的 Hook
@@ -34,60 +30,6 @@ type AnyAsyncFunction<P extends any[] = any[], R = any> = (...args: P) => Promis
  */
 declare function useMount(effect: EffectCallback | AnyAsyncFunction): void;
 //#endregion
-//#region ../../node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/tuple-to-union.d.ts
-/**
-Convert a tuple/array into a union type of its elements.
-
-This can be useful when you have a fixed set of allowed values and want a type defining only the allowed values, but do not want to repeat yourself.
-
-@example
-```
-import type {TupleToUnion} from 'type-fest';
-
-const destinations = ['a', 'b', 'c'] as const;
-
-type Destination = TupleToUnion<typeof destinations>;
-//=> 'a' | 'b' | 'c'
-
-function verifyDestination(destination: unknown): destination is Destination {
-	return destinations.includes(destination as any);
-}
-
-type RequestBody = {
-	deliverTo: Destination;
-};
-
-function verifyRequestBody(body: unknown): body is RequestBody {
-	const {deliverTo} = (body as any);
-	return typeof body === 'object' && body !== null && verifyDestination(deliverTo);
-}
-```
-
-Alternatively, you may use `typeof destinations[number]`. If `destinations` is a tuple, there is no difference. However if `destinations` is a string, the resulting type will the union of the characters in the string. Other types of `destinations` may result in a compile error. In comparison, TupleToUnion will return `never` if a tuple is not provided.
-
-@example
-```
-const destinations = ['a', 'b', 'c'] as const;
-
-type Destination = typeof destinations[number];
-//=> 'a' | 'b' | 'c'
-
-const erroringType = new Set(['a', 'b', 'c']);
-
-// @ts-expect-error
-type ErroringType = typeof erroringType[number];
-// Error: Type 'Set<string>' has no matching index signature for type 'number'. ts(2537)
-
-const numberBool: {[n: number]: boolean} = {1: true};
-
-type NumberBool = typeof numberBool[number];
-//=> boolean
-```
-
-@category Array
-*/
-type TupleToUnion<ArrayType> = ArrayType extends readonly unknown[] ? ArrayType[number] : never;
-//#endregion
 //#region src/react/useResponsive.d.ts
 type Breakpoint = TupleToUnion<typeof BREAK_POINTS>;
 type ResponsiveValues = Record<Breakpoint, boolean>;