@movk/nuxt 0.1.1 → 1.1.0

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

@@ -0,0 +1,590 @@
+import { z } from 'zod/v4';
+/**
+ * API 响应配置 Schema
+ * @description 定义业务状态码判断规则和数据/消息字段的映射关系
+ */
+export declare const apiResponseConfigSchema: 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>;
+/**
+ * 401 未授权处理配置 Schema
+ * @description 定义当接收到 401 响应时的自动处理行为
+ */
+export declare const apiUnauthorizedConfigSchema: z.ZodObject<{
+    redirect: z.ZodDefault<z.ZodBoolean>;
+    loginPath: z.ZodDefault<z.ZodString>;
+    clearSession: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * API 认证配置 Schema
+ * @description 定义认证令牌的来源、格式和请求头配置
+ */
+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>;
+    unauthorized: z.ZodOptional<z.ZodObject<{
+        redirect: z.ZodDefault<z.ZodBoolean>;
+        loginPath: z.ZodDefault<z.ZodString>;
+        clearSession: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Toast 提示配置 Schema
+ * @description 定义成功和错误提示的全局样式和行为
+ */
+export declare const apiToastConfigSchema: z.ZodObject<{
+    /**
+     * 是否启用 Toast 提示
+     * @defaultValue true
+     */
+    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.$strip>>;
+    /** 错误提示配置 */
+    error: z.ZodOptional<z.ZodObject<{
+        /**
+         * 是否显示错误提示
+         * @defaultValue true
+         */
+        show: z.ZodDefault<z.ZodBoolean>;
+        /**
+         * 提示颜色
+         * @defaultValue 'error'
+         */
+        color: z.ZodDefault<z.ZodString>;
+        /**
+         * 图标类名
+         * @defaultValue 'i-lucide-circle-x'
+         */
+        icon: z.ZodOptional<z.ZodString>;
+        /**
+         * 显示时长（毫秒）
+         * @defaultValue 3000
+         */
+        duration: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+/**
+ * API 端点公共配置 Schema
+ * @description 定义单个 API 端点的配置（可在客户端访问的配置）
+ */
+export declare const apiEndpointPublicConfigSchema: z.ZodObject<{
+    baseURL: z.ZodString;
+    alias: z.ZodOptional<z.ZodString>;
+    auth: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodOptional<z.ZodBoolean>;
+        tokenSource: z.ZodOptional<z.ZodEnum<{
+            custom: "custom";
+            session: "session";
+        }>>;
+        sessionTokenPath: z.ZodOptional<z.ZodString>;
+        tokenType: z.ZodOptional<z.ZodEnum<{
+            Bearer: "Bearer";
+            Basic: "Basic";
+            Custom: "Custom";
+        }>>;
+        customTokenType: z.ZodOptional<z.ZodString>;
+        headerName: z.ZodOptional<z.ZodString>;
+        unauthorized: z.ZodOptional<z.ZodObject<{
+            redirect: z.ZodOptional<z.ZodBoolean>;
+            loginPath: z.ZodOptional<z.ZodString>;
+            clearSession: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+    }, 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.$strip>>>;
+        error: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+            /**
+             * 是否显示错误提示
+             * @defaultValue true
+             */
+            show: z.ZodDefault<z.ZodBoolean>;
+            /**
+             * 提示颜色
+             * @defaultValue 'error'
+             */
+            color: z.ZodDefault<z.ZodString>;
+            /**
+             * 图标类名
+             * @defaultValue 'i-lucide-circle-x'
+             */
+            icon: z.ZodOptional<z.ZodString>;
+            /**
+             * 显示时长（毫秒）
+             * @defaultValue 3000
+             */
+            duration: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$loose>>>;
+    }, z.core.$loose>>;
+    response: 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>>;
+}, z.core.$strip>;
+/**
+ * API 端点私有配置 Schema
+ * @description 定义仅在服务端可访问的端点配置（不会暴露给客户端）
+ */
+export declare const apiEndpointPrivateConfigSchema: z.ZodObject<{
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Movk API 模块公共配置 Schema
+ * @description 定义模块的全局配置（可在客户端访问）
+ */
+export declare const movkApiPublicConfigSchema: z.ZodPipe<z.ZodObject<{
+    defaultEndpoint: z.ZodDefault<z.ZodString>;
+    debug: z.ZodDefault<z.ZodBoolean>;
+    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.ZodBoolean>;
+            tokenSource: z.ZodOptional<z.ZodEnum<{
+                custom: "custom";
+                session: "session";
+            }>>;
+            sessionTokenPath: z.ZodOptional<z.ZodString>;
+            tokenType: z.ZodOptional<z.ZodEnum<{
+                Bearer: "Bearer";
+                Basic: "Basic";
+                Custom: "Custom";
+            }>>;
+            customTokenType: z.ZodOptional<z.ZodString>;
+            headerName: z.ZodOptional<z.ZodString>;
+            unauthorized: z.ZodOptional<z.ZodObject<{
+                redirect: z.ZodOptional<z.ZodBoolean>;
+                loginPath: z.ZodOptional<z.ZodString>;
+                clearSession: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$strip>>;
+        }, 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.$strip>>>;
+            error: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+                /**
+                 * 是否显示错误提示
+                 * @defaultValue true
+                 */
+                show: z.ZodDefault<z.ZodBoolean>;
+                /**
+                 * 提示颜色
+                 * @defaultValue 'error'
+                 */
+                color: z.ZodDefault<z.ZodString>;
+                /**
+                 * 图标类名
+                 * @defaultValue 'i-lucide-circle-x'
+                 */
+                icon: z.ZodOptional<z.ZodString>;
+                /**
+                 * 显示时长（毫秒）
+                 * @defaultValue 3000
+                 */
+                duration: z.ZodDefault<z.ZodNumber>;
+            }, z.core.$loose>>>;
+        }, z.core.$loose>>;
+        response: 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>>;
+    }, z.core.$strip>>>;
+    response: 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>>;
+    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>;
+        unauthorized: z.ZodOptional<z.ZodObject<{
+            redirect: z.ZodDefault<z.ZodBoolean>;
+            loginPath: z.ZodDefault<z.ZodString>;
+            clearSession: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    toast: z.ZodOptional<z.ZodObject<{
+        /**
+         * 是否启用 Toast 提示
+         * @defaultValue true
+         */
+        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.$strip>>;
+        /** 错误提示配置 */
+        error: z.ZodOptional<z.ZodObject<{
+            /**
+             * 是否显示错误提示
+             * @defaultValue true
+             */
+            show: z.ZodDefault<z.ZodBoolean>;
+            /**
+             * 提示颜色
+             * @defaultValue 'error'
+             */
+            color: z.ZodDefault<z.ZodString>;
+            /**
+             * 图标类名
+             * @defaultValue 'i-lucide-circle-x'
+             */
+            icon: z.ZodOptional<z.ZodString>;
+            /**
+             * 显示时长（毫秒）
+             * @defaultValue 3000
+             */
+            duration: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>;
+}, z.core.$strip>, z.ZodTransform<{
+    response: {
+        successCodes: (string | number)[];
+        codeKey: string;
+        messageKey: string;
+        dataKey: string;
+    };
+    auth: {
+        enabled: boolean;
+        tokenSource: "custom" | "session";
+        sessionTokenPath: string;
+        tokenType: "Bearer" | "Basic" | "Custom";
+        headerName: string;
+        customTokenType?: string | undefined;
+        unauthorized?: {
+            redirect: boolean;
+            loginPath: string;
+            clearSession: boolean;
+        } | undefined;
+    };
+    toast: {
+        [x: string]: unknown;
+        enabled: boolean;
+        success?: {
+            show: boolean;
+            color: string;
+            duration: number;
+            icon?: string | undefined;
+        } | undefined;
+        error?: {
+            [x: string]: unknown;
+            show: boolean;
+            color: string;
+            duration: number;
+            icon?: string | undefined;
+        } | undefined;
+    };
+    defaultEndpoint: string;
+    debug: boolean;
+    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;
+            unauthorized?: {
+                redirect?: boolean | undefined;
+                loginPath?: string | undefined;
+                clearSession?: boolean | undefined;
+            } | undefined;
+        } | undefined;
+        toast?: {
+            [x: string]: unknown;
+            enabled?: boolean | undefined;
+            success?: {
+                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;
+        response?: {
+            successCodes?: (string | number)[] | undefined;
+            codeKey?: string | undefined;
+            messageKey?: string | undefined;
+            dataKey?: string | undefined;
+        } | undefined;
+    }>;
+}, {
+    defaultEndpoint: string;
+    debug: boolean;
+    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;
+            unauthorized?: {
+                redirect?: boolean | undefined;
+                loginPath?: string | undefined;
+                clearSession?: boolean | undefined;
+            } | undefined;
+        } | undefined;
+        toast?: {
+            [x: string]: unknown;
+            enabled?: boolean | undefined;
+            success?: {
+                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;
+        response?: {
+            successCodes?: (string | number)[] | undefined;
+            codeKey?: string | undefined;
+            messageKey?: string | undefined;
+            dataKey?: string | undefined;
+        } | undefined;
+    }>;
+    response?: {
+        successCodes: (string | number)[];
+        codeKey: string;
+        messageKey: string;
+        dataKey: string;
+    } | undefined;
+    auth?: {
+        enabled: boolean;
+        tokenSource: "custom" | "session";
+        sessionTokenPath: string;
+        tokenType: "Bearer" | "Basic" | "Custom";
+        headerName: string;
+        customTokenType?: string | undefined;
+        unauthorized?: {
+            redirect: boolean;
+            loginPath: string;
+            clearSession: boolean;
+        } | undefined;
+    } | undefined;
+    toast?: {
+        [x: string]: unknown;
+        enabled: boolean;
+        success?: {
+            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;
+}>>;
+/**
+ * Movk API 模块私有配置 Schema
+ * @description 定义模块的私有配置（仅服务端可访问，不会暴露给客户端）
+ */
+export declare const movkApiPrivateConfigSchema: z.ZodObject<{
+    endpoints: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * Movk API 模块完整配置 Schema
+ * @description 定义模块的完整配置（公共+私有），用于模块初始化时的配置验证
+ */
+export declare const movkApiFullConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    defaultEndpoint: z.ZodDefault<z.ZodString>;
+    debug: z.ZodDefault<z.ZodBoolean>;
+    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.ZodBoolean>;
+            tokenSource: z.ZodOptional<z.ZodEnum<{
+                custom: "custom";
+                session: "session";
+            }>>;
+            sessionTokenPath: z.ZodOptional<z.ZodString>;
+            tokenType: z.ZodOptional<z.ZodEnum<{
+                Bearer: "Bearer";
+                Basic: "Basic";
+                Custom: "Custom";
+            }>>;
+            customTokenType: z.ZodOptional<z.ZodString>;
+            headerName: z.ZodOptional<z.ZodString>;
+            unauthorized: z.ZodOptional<z.ZodObject<{
+                redirect: z.ZodOptional<z.ZodBoolean>;
+                loginPath: z.ZodOptional<z.ZodString>;
+                clearSession: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$strip>>;
+        }, 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.$strip>>>;
+            error: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+                /**
+                 * 是否显示错误提示
+                 * @defaultValue true
+                 */
+                show: z.ZodDefault<z.ZodBoolean>;
+                /**
+                 * 提示颜色
+                 * @defaultValue 'error'
+                 */
+                color: z.ZodDefault<z.ZodString>;
+                /**
+                 * 图标类名
+                 * @defaultValue 'i-lucide-circle-x'
+                 */
+                icon: z.ZodOptional<z.ZodString>;
+                /**
+                 * 显示时长（毫秒）
+                 * @defaultValue 3000
+                 */
+                duration: z.ZodDefault<z.ZodNumber>;
+            }, z.core.$loose>>>;
+        }, z.core.$loose>>;
+        response: 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>>>;
+    response: 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>>;
+    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>;
+        unauthorized: z.ZodOptional<z.ZodObject<{
+            redirect: z.ZodDefault<z.ZodBoolean>;
+            loginPath: z.ZodDefault<z.ZodString>;
+            clearSession: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    toast: z.ZodOptional<z.ZodObject<{
+        /**
+         * 是否启用 Toast 提示
+         * @defaultValue true
+         */
+        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.$strip>>;
+        /** 错误提示配置 */
+        error: z.ZodOptional<z.ZodObject<{
+            /**
+             * 是否显示错误提示
+             * @defaultValue true
+             */
+            show: z.ZodDefault<z.ZodBoolean>;
+            /**
+             * 提示颜色
+             * @defaultValue 'error'
+             */
+            color: z.ZodDefault<z.ZodString>;
+            /**
+             * 图标类名
+             * @defaultValue 'i-lucide-circle-x'
+             */
+            icon: z.ZodOptional<z.ZodString>;
+            /**
+             * 显示时长（毫秒）
+             * @defaultValue 3000
+             */
+            duration: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>;
+}, z.core.$strip>;