@movk/nuxt 1.0.0 → 1.1.0

package/dist/runtime/utils/api-utils.d.ts

@@ -1,64 +1,79 @@
 import type { FetchContext, FetchHooks } from 'ofetch';
-import type { ApiResponse, ApiError, ApiSuccessConfig, ApiToastConfig, RequestToastOptions, ResolvedEndpointConfig } from '../types/api.js';
+import type { ApiResponse, ApiError, ApiResponseConfig, ApiToastConfig, RequestToastOptions, ResolvedEndpointConfig } from '../types/api.js';
 /**
- * 检查业务状态码是否成功
+ * 判断API响应是否业务成功
+ * @param response - API响应对象
+ * @param config - 响应配置（包含codeKey和successCodes）
+ * @returns 是否业务成功
  */
-export declare function isBusinessSuccess(response: ApiResponse, config?: Partial<ApiSuccessConfig>): boolean;
+export declare function isBusinessSuccess(response: ApiResponse, config?: Partial<ApiResponseConfig>): boolean;
 /**
- * 从响应中提取消息
+ * 从API响应中提取消息内容
+ * @param response - API响应对象
+ * @param config - 响应配置（包含messageKey）
+ * @returns 消息字符串或undefined
  */
-export declare function extractMessage(response: ApiResponse, config?: Partial<ApiSuccessConfig>): string | undefined;
+export declare function extractMessage(response: ApiResponse, config?: Partial<ApiResponseConfig>): string | undefined;
 /**
- * 从响应中提取数据
+ * 从API响应中提取业务数据
+ * @param response - API响应对象
+ * @param config - 响应配置（包含dataKey）
+ * @returns 业务数据
  */
-export declare function extractData<T>(response: ApiResponse<T>, config?: Partial<ApiSuccessConfig>): T;
+export declare function extractData<T>(response: ApiResponse<T>, config?: Partial<ApiResponseConfig>): T;
 /**
- * 创建 API 业务错误
+ * 创建业务错误对象
+ * @param response - API响应对象
+ * @param message - 错误消息（可选）
+ * @returns 业务错误对象
  */
 export declare function createApiError(response: ApiResponse, message?: string): ApiError;
 /**
- * 从请求选项中提取 Toast 消息
+ * 提取Toast消息内容
+ * @param toast - Toast配置选项
+ * @param type - 消息类型
+ * @param fallback - 默认消息
+ * @returns 最终显示的消息内容
  */
 export declare function extractToastMessage(toast: RequestToastOptions | false | undefined, type: 'success' | 'error', fallback: string): string;
 /**
- * 显示 Toast 提示
+ * 显示Toast提示
+ * @param type - 提示类型
+ * @param message - 提示消息
+ * @param requestOptions - 请求级别的Toast配置
+ * @param globalConfig - 全局Toast配置
  */
 export declare function showToast(type: 'success' | 'error', message: string | undefined, requestOptions: RequestToastOptions | false | undefined, globalConfig: Partial<ApiToastConfig>): void;
 interface CreateTransformOptions<ResT, DataT = ResT> {
     skipBusinessCheck: boolean;
     userTransform?: (data: ResT) => DataT;
-    successConfig: Partial<ApiSuccessConfig>;
+    successConfig: Partial<ApiResponseConfig>;
 }
 /**
- * 创建 useFetch transform 函数
- *
- * 处理流程:
- * 1. 业务状态码检查 → 失败时抛出 ApiError
- * 2. 解包数据（提取 response.data）
- * 3. 用户自定义 transform（接收解包后的数据）
+ * 创建响应转换函数
+ * @description 用于 useFetch 的 transform 选项，处理业务状态码检查和数据提取
+ * @param options - 转换选项（包含skipBusinessCheck、userTransform、successConfig）
+ * @returns 响应转换函数
  */
 export declare function createTransform<ResT, DataT = ResT>(options: CreateTransformOptions<ResT, DataT>): (response: ApiResponse<ResT>) => DataT;
 type HookFunction = (context: FetchContext) => void | Promise<void>;
 /**
- * 合并多个 hook 函数，确保所有 hooks 都会执行
+ * 合并多个钩子函数为一个
+ * @param hooks - 钩子函数数组
+ * @returns 合并后的钩子函数
  */
 export declare function mergeHooks(...hooks: (HookFunction | undefined)[]): HookFunction;
 /**
- * 合并 FetchHooks 对象，每个 hook 类型单独合并
+ * 合并内置钩子和用户钩子
+ * @param builtinHooks - 内置钩子集合
+ * @param userHooks - 用户自定义钩子集合
+ * @returns 合并后的完整钩子集合
  */
 export declare function mergeFetchHooks(builtinHooks: Partial<FetchHooks>, userHooks: Partial<FetchHooks>): FetchHooks;
 /**
- * 获取认证 Headers
- *
- * 根据端点配置获取认证相关的 headers（如 Authorization）
- * 用于原生 fetch/XHR 请求（如带进度的上传下载）
- *
- * @example
- * ```ts
- * const config = $api.getConfig()
- * const authHeaders = getAuthHeaders(config)
- * fetch(url, { headers: { ...headers, ...authHeaders } })
- * ```
+ * 获取认证请求头
+ * @param config - 已解析的端点配置
+ * @returns 认证请求头对象
  */
 export declare function getAuthHeaders(config: ResolvedEndpointConfig): Record<string, string>;
 export {};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@movk/nuxt",
   "type": "module",
-  "version": "1.0.0",
-  "packageManager": "pnpm@10.26.1",
+  "version": "1.1.0",
+  "packageManager": "pnpm@10.28.0",
   "description": "Modular engineering suite for Nuxt 4 with schema-driven forms, API integration, UI components and composables",
   "author": "YiXuan <mhaibaraai@gmail.com>",
   "license": "MIT",
@@ -12,7 +12,7 @@
   },
   "homepage": "https://nuxt.mhaibaraai.cn",
   "engines": {
-    "node": "^20.x || ^22.x"
+    "node": "^22.x || ^24.x"
   },
   "bugs": {
     "url": "https://github.com/mhaibaraai/movk-nuxt/issues"
@@ -46,8 +46,8 @@
     "dist"
   ],
   "peerDependencies": {
-    "@nuxt/ui": ">=4.2.1",
-    "zod": ">=4.1.13"
+    "@nuxt/ui": ">=4.3.0",
+    "zod": ">=4.3.5"
   },
   "scripts": {
     "prepack": "pnpm build",
@@ -60,23 +60,25 @@
     "release": "release-it && npm publish",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "typecheck": "vue-tsc --noEmit && nuxt typecheck playground",
-    "clean": "tsx scripts/rm.ts",
+    "typecheck": "vue-tsc --noEmit && nuxt typecheck playground && nuxt typecheck docs",
+    "clean": "movk-clean",
     "test": "vitest"
   },
   "dependencies": {
-    "@iconify-json/lucide": "^1.2.82",
+    "@iconify-json/lucide": "^1.2.86",
     "@internationalized/date": "^3.10.1",
-    "@movk/core": "^1.0.2",
+    "@movk/core": "^1.1.0",
     "@nuxt/image": "^2.0.0",
     "@nuxt/ui": "^4.3.0",
     "@vueuse/core": "^14.1.0",
     "@vueuse/nuxt": "^14.1.0",
     "defu": "^6.1.4",
-    "nuxt-auth-utils": "^0.5.26",
-    "tailwindcss": "^4.1.18",
+    "motion-v": "^1.9.0",
+    "nuxt-auth-utils": "^0.5.27",
+    "nuxt-og-image": "^5.1.13",
     "scule": "^1.3.0",
-    "zod": "^4.2.1"
+    "tailwindcss": "^4.1.18",
+    "zod": "^4.3.5"
   },
   "devDependencies": {
     "@nuxt/devtools": "^3.1.1",
@@ -84,17 +86,15 @@
     "@nuxt/kit": "^4.2.2",
     "@nuxt/module-builder": "^1.0.2",
     "@nuxt/schema": "^4.2.2",
-    "@nuxt/test-utils": "^3.21.0",
+    "@nuxt/test-utils": "^3.23.0",
     "@release-it/bumper": "^7.0.5",
     "@release-it/conventional-changelog": "^10.0.4",
-    "@vitest/coverage-v8": "^4.0.16",
-    "jsdom": "^27.3.0",
+    "@vitest/coverage-v8": "^4.0.17",
     "eslint": "9.39.2",
-    "fast-glob": "^3.3.3",
+    "jsdom": "^27.4.0",
     "nuxt": "^4.2.2",
-    "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.16",
-    "vue-tsc": "^3.2.1"
+    "vitest": "^4.0.17",
+    "vue-tsc": "^3.2.2"
   }
 }