@movk/nuxt 0.1.1 → 1.0.0

package/dist/runtime/plugins/api.factory.js

@@ -0,0 +1,188 @@
+import { getPath, triggerDownload, extractFilename } from "@movk/core";
+import {
+  showToast,
+  isBusinessSuccess,
+  extractMessage,
+  extractToastMessage
+} from "../utils/api-utils.js";
+import { defineNuxtPlugin, useRuntimeConfig, navigateTo, useNuxtApp, useUserSession } from "#imports";
+import defu from "defu";
+function getUserSession() {
+  try {
+    const nuxtApp = useNuxtApp();
+    return nuxtApp.runWithContext(() => useUserSession());
+  } catch {
+    return null;
+  }
+}
+function getTokenFromSession(tokenPath) {
+  const userSession = getUserSession();
+  if (!userSession?.session?.value) return null;
+  const sessionData = userSession.session.value;
+  return getPath(sessionData, tokenPath) || null;
+}
+function buildAuthHeader(token, config) {
+  const tokenType = config.tokenType === "Custom" ? config.customTokenType || "" : config.tokenType || "Bearer";
+  return tokenType ? `${tokenType} ${token}` : token;
+}
+async function handleUnauthorized(config) {
+  const userSession = getUserSession();
+  if (config.clearSessionOnUnauthorized && userSession?.clear) {
+    await userSession.clear();
+  }
+  if (config.redirectOnUnauthorized) {
+    const loginPath = config.loginPath || "/login";
+    const nuxtApp = useNuxtApp();
+    await nuxtApp.runWithContext(() => navigateTo(loginPath));
+  }
+}
+function getApiFetchContext(context) {
+  return context.options.context || {};
+}
+function createBuiltinHooks(resolvedConfig, moduleConfig) {
+  const { auth: authConfig, toast: toastConfig, success: successConfig } = resolvedConfig;
+  return {
+    onRequest(context) {
+      if (authConfig.enabled) {
+        const tokenPath = authConfig.sessionTokenPath || "token";
+        const token = getTokenFromSession(tokenPath);
+        if (token) {
+          const headerName = authConfig.headerName || "Authorization";
+          const headerValue = buildAuthHeader(token, authConfig);
+          context.options.headers = context.options.headers || new Headers();
+          if (context.options.headers instanceof Headers) {
+            context.options.headers.set(headerName, headerValue);
+          } else {
+            context.options.headers[headerName] = headerValue;
+          }
+        }
+      }
+      if (moduleConfig.debug) {
+        console.log(`[Movk API] Request: ${context.options.method || "GET"} ${resolvedConfig.baseURL}${context.request}`);
+      }
+    },
+    async onRequestError({ error }) {
+      if (moduleConfig.debug) {
+        console.error("[Movk API] Request Error:", error);
+      }
+    },
+    async onResponse(context) {
+      const response = context.response;
+      const data = response._data;
+      if (moduleConfig.debug) {
+        console.log("[Movk API] Response:", data);
+      }
+      if (!import.meta.client) return;
+      const { toast, skipBusinessCheck } = getApiFetchContext(context);
+      const isSuccess = skipBusinessCheck || isBusinessSuccess(data, successConfig);
+      const message = extractMessage(data, successConfig);
+      if (isSuccess) {
+        const successMessage = toast !== false ? toast?.successMessage || message : void 0;
+        showToast("success", successMessage, toast, toastConfig);
+      }
+    },
+    async onResponseError(context) {
+      const { response } = context;
+      if (response.status === 401) {
+        await handleUnauthorized(authConfig);
+      }
+      if (moduleConfig.debug) {
+        console.error("[Movk API] Error:", response.status, response._data);
+      }
+      if (!import.meta.client) return;
+      const { toast } = getApiFetchContext(context);
+      const data = response._data;
+      const message = data ? extractMessage(data, successConfig) : void 0;
+      const errorMessage = toast !== false ? toast?.errorMessage || message || `\u8BF7\u6C42\u5931\u8D25 (${response.status})` : void 0;
+      showToast("error", errorMessage, toast, toastConfig);
+    }
+  };
+}
+function createApiClient(resolvedConfig, moduleConfig, getOrCreateEndpoint) {
+  const builtinHooks = createBuiltinHooks(resolvedConfig, moduleConfig);
+  resolvedConfig.builtinHooks = builtinHooks;
+  const $fetchInstance = $fetch.create({
+    baseURL: resolvedConfig.baseURL,
+    headers: resolvedConfig.headers,
+    onRequest: builtinHooks.onRequest,
+    onRequestError: builtinHooks.onRequestError,
+    onResponse: builtinHooks.onResponse,
+    onResponseError: builtinHooks.onResponseError
+  });
+  const download = async (url, filename, options = {}) => {
+    const { toast, ...fetchOptions } = options;
+    const response = await $fetchInstance.raw(url, {
+      ...fetchOptions,
+      method: "GET",
+      responseType: "blob",
+      context: { toast }
+    });
+    if (!response._data) {
+      throw new Error("\u4E0B\u8F7D\u5931\u8D25: \u672A\u63A5\u6536\u5230\u6570\u636E");
+    }
+    const finalFilename = filename || extractFilename(response.headers, url.split("/").pop() || "download");
+    triggerDownload(response._data, finalFilename);
+    if (import.meta.client && toast !== false) {
+      const message = extractToastMessage(toast, "success", `\u4E0B\u8F7D\u6210\u529F: ${finalFilename}`);
+      showToast("success", message, toast, resolvedConfig.toast);
+    }
+  };
+  const upload = async (url, file, options = {}) => {
+    const { toast, fieldName = "file", ...fetchOptions } = options;
+    const formData = file instanceof FormData ? file : (() => {
+      const fd = new FormData();
+      const files = Array.isArray(file) ? file : [file];
+      files.forEach((f) => fd.append(fieldName, f));
+      return fd;
+    })();
+    return $fetchInstance(url, {
+      ...fetchOptions,
+      method: "POST",
+      body: formData,
+      context: { toast }
+    });
+  };
+  return {
+    $fetch: $fetchInstance,
+    use: (endpoint) => getOrCreateEndpoint(endpoint),
+    download,
+    upload,
+    getConfig: () => resolvedConfig
+  };
+}
+export default defineNuxtPlugin(() => {
+  const moduleConfig = useRuntimeConfig().public.movkApi;
+  if (!moduleConfig.enabled) {
+    return;
+  }
+  const endpointCache = /* @__PURE__ */ new Map();
+  const getOrCreateEndpoint = (endpointName) => {
+    if (endpointCache.has(endpointName)) {
+      return endpointCache.get(endpointName);
+    }
+    const endpoints = moduleConfig.endpoints || {};
+    const endpointConfig = endpoints[endpointName];
+    if (!endpointConfig) {
+      console.warn(`[Movk API] Endpoint "${endpointName}" not found, using default`);
+      return getOrCreateEndpoint(moduleConfig.defaultEndpoint || "default");
+    }
+    const resolvedConfig = {
+      ...endpointConfig,
+      auth: defu(endpointConfig.auth, moduleConfig.auth),
+      toast: defu(endpointConfig.toast, moduleConfig.toast),
+      success: defu(endpointConfig.success, moduleConfig.success)
+    };
+    const client = createApiClient(
+      resolvedConfig,
+      moduleConfig,
+      getOrCreateEndpoint
+    );
+    endpointCache.set(endpointName, client);
+    return client;
+  };
+  const defaultEndpoint = moduleConfig.defaultEndpoint || "default";
+  const api = getOrCreateEndpoint(defaultEndpoint);
+  return {
+    provide: { api }
+  };
+});

package/dist/runtime/schemas/api.d.ts

@@ -0,0 +1,354 @@
+import { z } from 'zod/v4';
+/**
+ * 成功响应判断配置 Schema
+ */
+export declare const apiSuccessConfigSchema: z.ZodObject<{
+    successCodes: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+    codeKey: z.ZodDefault<z.ZodString>;
+    messageKey: z.ZodDefault<z.ZodString>;
+    dataKey: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Session 管理配置 Schema
+ * 用于登录流程中自动设置 nuxt-auth-utils session
+ */
+export declare const apiSessionConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    userInfoPath: z.ZodOptional<z.ZodString>;
+    tokenPath: z.ZodDefault<z.ZodString>;
+    userDataPath: z.ZodDefault<z.ZodString>;
+    sessionTokenPath: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Auth 认证配置 Schema
+ * 使用 nuxt-auth-utils 进行认证管理
+ */
+export declare const apiAuthConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    tokenSource: z.ZodDefault<z.ZodEnum<{
+        custom: "custom";
+        session: "session";
+    }>>;
+    sessionTokenPath: z.ZodDefault<z.ZodString>;
+    tokenType: z.ZodDefault<z.ZodEnum<{
+        Bearer: "Bearer";
+        Basic: "Basic";
+        Custom: "Custom";
+    }>>;
+    customTokenType: z.ZodOptional<z.ZodString>;
+    headerName: z.ZodDefault<z.ZodString>;
+    redirectOnUnauthorized: z.ZodDefault<z.ZodBoolean>;
+    loginPath: z.ZodDefault<z.ZodString>;
+    clearSessionOnUnauthorized: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Toast 提示配置 Schema
+ * @see https://ui.nuxt.com/docs/composables/use-toast
+ */
+export declare const apiToastConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    success: z.ZodOptional<z.ZodObject<{
+        show: z.ZodDefault<z.ZodBoolean>;
+        color: z.ZodDefault<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+        duration: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$loose>>;
+    error: z.ZodOptional<z.ZodObject<{
+        show: z.ZodDefault<z.ZodBoolean>;
+        color: z.ZodDefault<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+        duration: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$loose>>;
+}, z.core.$strip>;
+/**
+ * 单个 API 端点配置 Schema
+ */
+export declare const apiEndpointConfigSchema: z.ZodObject<{
+    baseURL: z.ZodString;
+    alias: z.ZodOptional<z.ZodString>;
+    auth: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        tokenSource: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+            custom: "custom";
+            session: "session";
+        }>>>;
+        sessionTokenPath: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        tokenType: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+            Bearer: "Bearer";
+            Basic: "Basic";
+            Custom: "Custom";
+        }>>>;
+        customTokenType: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        headerName: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        redirectOnUnauthorized: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        loginPath: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        clearSessionOnUnauthorized: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    }, z.core.$strip>>;
+    toast: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        success: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+            show: z.ZodDefault<z.ZodBoolean>;
+            color: z.ZodDefault<z.ZodString>;
+            icon: z.ZodOptional<z.ZodString>;
+            duration: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$loose>>>;
+        error: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+            show: z.ZodDefault<z.ZodBoolean>;
+            color: z.ZodDefault<z.ZodString>;
+            icon: z.ZodOptional<z.ZodString>;
+            duration: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$loose>>>;
+    }, z.core.$strip>>;
+    success: z.ZodOptional<z.ZodObject<{
+        successCodes: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>>;
+        codeKey: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        messageKey: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        dataKey: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    }, z.core.$strip>>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Movk API 模块配置 Schema
+ */
+export declare const movkApiModuleOptionsSchema: z.ZodPipe<z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    defaultEndpoint: z.ZodDefault<z.ZodString>;
+    endpoints: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        baseURL: z.ZodString;
+        alias: z.ZodOptional<z.ZodString>;
+        auth: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            tokenSource: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                custom: "custom";
+                session: "session";
+            }>>>;
+            sessionTokenPath: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            tokenType: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
+                Bearer: "Bearer";
+                Basic: "Basic";
+                Custom: "Custom";
+            }>>>;
+            customTokenType: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+            headerName: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            redirectOnUnauthorized: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            loginPath: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            clearSessionOnUnauthorized: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        }, z.core.$strip>>;
+        toast: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            success: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+                show: z.ZodDefault<z.ZodBoolean>;
+                color: z.ZodDefault<z.ZodString>;
+                icon: z.ZodOptional<z.ZodString>;
+                duration: z.ZodDefault<z.ZodNumber>;
+            }, z.core.$loose>>>;
+            error: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+                show: z.ZodDefault<z.ZodBoolean>;
+                color: z.ZodDefault<z.ZodString>;
+                icon: z.ZodOptional<z.ZodString>;
+                duration: z.ZodDefault<z.ZodNumber>;
+            }, z.core.$loose>>>;
+        }, z.core.$strip>>;
+        success: z.ZodOptional<z.ZodObject<{
+            successCodes: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>>;
+            codeKey: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            messageKey: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            dataKey: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        }, z.core.$strip>>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>>>;
+    auth: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        tokenSource: z.ZodDefault<z.ZodEnum<{
+            custom: "custom";
+            session: "session";
+        }>>;
+        sessionTokenPath: z.ZodDefault<z.ZodString>;
+        tokenType: z.ZodDefault<z.ZodEnum<{
+            Bearer: "Bearer";
+            Basic: "Basic";
+            Custom: "Custom";
+        }>>;
+        customTokenType: z.ZodOptional<z.ZodString>;
+        headerName: z.ZodDefault<z.ZodString>;
+        redirectOnUnauthorized: z.ZodDefault<z.ZodBoolean>;
+        loginPath: z.ZodDefault<z.ZodString>;
+        clearSessionOnUnauthorized: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    toast: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        success: z.ZodOptional<z.ZodObject<{
+            show: z.ZodDefault<z.ZodBoolean>;
+            color: z.ZodDefault<z.ZodString>;
+            icon: z.ZodOptional<z.ZodString>;
+            duration: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$loose>>;
+        error: z.ZodOptional<z.ZodObject<{
+            show: z.ZodDefault<z.ZodBoolean>;
+            color: z.ZodDefault<z.ZodString>;
+            icon: z.ZodOptional<z.ZodString>;
+            duration: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$loose>>;
+    }, z.core.$strip>>;
+    success: z.ZodOptional<z.ZodObject<{
+        successCodes: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+        codeKey: z.ZodDefault<z.ZodString>;
+        messageKey: z.ZodDefault<z.ZodString>;
+        dataKey: z.ZodDefault<z.ZodString>;
+    }, z.core.$strip>>;
+    debug: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodTransform<{
+    auth: {
+        enabled: boolean;
+        tokenSource: "custom" | "session";
+        sessionTokenPath: string;
+        tokenType: "Bearer" | "Basic" | "Custom";
+        headerName: string;
+        redirectOnUnauthorized: boolean;
+        loginPath: string;
+        clearSessionOnUnauthorized: boolean;
+        customTokenType?: string | undefined;
+    };
+    toast: {
+        enabled: boolean;
+        success?: {
+            [x: string]: unknown;
+            show: boolean;
+            color: string;
+            duration: number;
+            icon?: string | undefined;
+        } | undefined;
+        error?: {
+            [x: string]: unknown;
+            show: boolean;
+            color: string;
+            duration: number;
+            icon?: string | undefined;
+        } | undefined;
+    };
+    success: {
+        successCodes: (string | number)[];
+        codeKey: string;
+        messageKey: string;
+        dataKey: string;
+    };
+    enabled: boolean;
+    defaultEndpoint: string;
+    endpoints: Record<string, {
+        baseURL: string;
+        alias?: string | undefined;
+        auth?: {
+            enabled?: boolean | undefined;
+            tokenSource?: "custom" | "session" | undefined;
+            sessionTokenPath?: string | undefined;
+            tokenType?: "Bearer" | "Basic" | "Custom" | undefined;
+            customTokenType?: string | undefined;
+            headerName?: string | undefined;
+            redirectOnUnauthorized?: boolean | undefined;
+            loginPath?: string | undefined;
+            clearSessionOnUnauthorized?: boolean | undefined;
+        } | undefined;
+        toast?: {
+            enabled?: boolean | undefined;
+            success?: {
+                [x: string]: unknown;
+                show: boolean;
+                color: string;
+                duration: number;
+                icon?: string | undefined;
+            } | undefined;
+            error?: {
+                [x: string]: unknown;
+                show: boolean;
+                color: string;
+                duration: number;
+                icon?: string | undefined;
+            } | undefined;
+        } | undefined;
+        success?: {
+            successCodes?: (string | number)[] | undefined;
+            codeKey?: string | undefined;
+            messageKey?: string | undefined;
+            dataKey?: string | undefined;
+        } | undefined;
+        headers?: Record<string, string> | undefined;
+    }>;
+    debug: boolean;
+}, {
+    enabled: boolean;
+    defaultEndpoint: string;
+    endpoints: Record<string, {
+        baseURL: string;
+        alias?: string | undefined;
+        auth?: {
+            enabled?: boolean | undefined;
+            tokenSource?: "custom" | "session" | undefined;
+            sessionTokenPath?: string | undefined;
+            tokenType?: "Bearer" | "Basic" | "Custom" | undefined;
+            customTokenType?: string | undefined;
+            headerName?: string | undefined;
+            redirectOnUnauthorized?: boolean | undefined;
+            loginPath?: string | undefined;
+            clearSessionOnUnauthorized?: boolean | undefined;
+        } | undefined;
+        toast?: {
+            enabled?: boolean | undefined;
+            success?: {
+                [x: string]: unknown;
+                show: boolean;
+                color: string;
+                duration: number;
+                icon?: string | undefined;
+            } | undefined;
+            error?: {
+                [x: string]: unknown;
+                show: boolean;
+                color: string;
+                duration: number;
+                icon?: string | undefined;
+            } | undefined;
+        } | undefined;
+        success?: {
+            successCodes?: (string | number)[] | undefined;
+            codeKey?: string | undefined;
+            messageKey?: string | undefined;
+            dataKey?: string | undefined;
+        } | undefined;
+        headers?: Record<string, string> | undefined;
+    }>;
+    debug: boolean;
+    auth?: {
+        enabled: boolean;
+        tokenSource: "custom" | "session";
+        sessionTokenPath: string;
+        tokenType: "Bearer" | "Basic" | "Custom";
+        headerName: string;
+        redirectOnUnauthorized: boolean;
+        loginPath: string;
+        clearSessionOnUnauthorized: boolean;
+        customTokenType?: string | undefined;
+    } | undefined;
+    toast?: {
+        enabled: boolean;
+        success?: {
+            [x: string]: unknown;
+            show: boolean;
+            color: string;
+            duration: number;
+            icon?: string | undefined;
+        } | undefined;
+        error?: {
+            [x: string]: unknown;
+            show: boolean;
+            color: string;
+            duration: number;
+            icon?: string | undefined;
+        } | undefined;
+    } | undefined;
+    success?: {
+        successCodes: (string | number)[];
+        codeKey: string;
+        messageKey: string;
+        dataKey: string;
+    } | undefined;
+}>>;