npm - @lytjs/plugin-data-fetch - Versions diffs - 6.7.0 → 6.9.0 - Mend

@lytjs/plugin-data-fetch 6.7.0 → 6.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,196 @@
+import * as _lytjs_core from '@lytjs/core';
+/**
+ * @lytjs/plugin-data-fetch - 类型定义
+ */
+interface RequestOptions extends RequestInit {
+    /** 基础 URL */
+    baseUrl?: string;
+    /** 超时时间（毫秒） */
+    timeout?: number;
+    /** 重试次数 */
+    retries?: number;
+    /** 重试延迟（毫秒） */
+    retryDelay?: number;
+    /** 缓存策略 */
+    cacheStrategy?: 'no-cache' | 'cache-first' | 'network-first' | 'cache-only';
+    /** 缓存时间（毫秒） */
+    cacheTime?: number;
+    /** 请求标识，用于缓存键生成 */
+    requestKey?: string;
+    /** 是否取消重复请求 */
+    cancelDuplicate?: boolean;
+    /** 自定义错误处理 */
+    onError?: (error: FetchError) => void | Promise<void>;
+}
+interface FetchError extends Error {
+    /** HTTP 状态码 */
+    status?: number;
+    /** 原始响应 */
+    response?: Response;
+    /** 原始错误 */
+    originalError?: Error;
+    /** 请求配置 */
+    config?: RequestOptions;
+}
+interface CacheEntry<T = unknown> {
+    /** 缓存数据 */
+    data: T;
+    /** 过期时间 */
+    expiresAt: number;
+    /** 创建时间 */
+    createdAt: number;
+}
+interface CacheStorage {
+    /** 获取缓存 */
+    get<T = unknown>(key: string): CacheEntry<T> | null;
+    /** 设置缓存 */
+    set<T = unknown>(key: string, value: CacheEntry<T>): void;
+    /** 删除缓存 */
+    delete(key: string): void;
+    /** 清空缓存 */
+    clear(): void;
+    /** 检查缓存是否存在且有效 */
+    has(key: string): boolean;
+}
+interface Interceptor<T = unknown> {
+    /** 请求拦截器 */
+    request?: (config: RequestOptions) => RequestOptions | Promise<RequestOptions>;
+    /** 响应拦截器 */
+    response?: (response: T) => T | Promise<T>;
+    /** 错误拦截器 */
+    error?: (error: FetchError) => FetchError | Promise<FetchError>;
+}
+interface FetchState<T = unknown> {
+    /** 请求数据 */
+    data: T | null;
+    /** 加载状态 */
+    isLoading: boolean;
+    /** 错误状态 */
+    error: FetchError | null;
+    /** 是否已完成 */
+    isSuccess: boolean;
+    /** 是否失败 */
+    isError: boolean;
+    /** 请求次数 */
+    refetchCount: number;
+}
+interface FetchInstance<T = unknown> {
+    /** 当前状态 */
+    state: Readonly<FetchState<T>>;
+    /** 发起请求 */
+    fetch(): Promise<T>;
+    /** 重新请求 */
+    refetch(): Promise<T>;
+    /** 取消请求 */
+    cancel(): void;
+    /** 手动更新数据 */
+    setData(data: T | ((prev: T | null) => T)): void;
+    /** 手动更新错误 */
+    setError(error: FetchError | null): void;
+    /** 清空状态 */
+    reset(): void;
+}
+interface FetchPluginOptions {
+    /** 基础 URL */
+    baseUrl?: string;
+    /** 默认超时时间 */
+    timeout?: number;
+    /** 默认重试次数 */
+    retries?: number;
+    /** 默认重试延迟 */
+    retryDelay?: number;
+    /** 默认缓存策略 */
+    defaultCacheStrategy?: RequestOptions['cacheStrategy'];
+    /** 默认缓存时间 */
+    defaultCacheTime?: number;
+    /** 请求拦截器 */
+    requestInterceptors?: Interceptor['request'][];
+    /** 响应拦截器 */
+    responseInterceptors?: Interceptor['response'][];
+    /** 错误拦截器 */
+    errorInterceptors?: Interceptor['error'][];
+    /** 自定义缓存存储 */
+    cacheStorage?: CacheStorage;
+}
+interface RequestInterceptor {
+    (config: RequestOptions): RequestOptions | Promise<RequestOptions>;
+}
+interface ResponseInterceptor {
+    <T = unknown>(response: T): T | Promise<T>;
+}
+interface ErrorInterceptor {
+    (error: FetchError): FetchError | Promise<FetchError>;
+}
+/**
+ * 默认内存缓存实现
+ */
+declare class DefaultCacheStorage implements CacheStorage {
+    private cache;
+    get<T = unknown>(key: string): CacheEntry<T> | null;
+    set<T = unknown>(key: string, value: CacheEntry<T>): void;
+    delete(key: string): void;
+    clear(): void;
+    has(key: string): boolean;
+}
+/**
+ * 生成缓存键
+ */
+declare function generateCacheKey(url: string, options?: RequestOptions): string;
+/**
+ * 创建数据获取实例
+ */
+declare function createFetch<T = unknown>(url: string, options?: RequestOptions, globalOptions?: FetchPluginOptions): FetchInstance<T>;
+/**
+ * 创建 Fetch 管理器
+ */
+declare function createFetchManager(globalOptions?: FetchPluginOptions): {
+    /**
+     * 创建 Fetch 实例
+     */
+    createFetch<T = unknown>(url: string, options?: RequestOptions): FetchInstance<T>;
+    /**
+     * 简单 GET 请求
+     */
+    get<T = unknown>(url: string, options?: RequestOptions): Promise<T>;
+    /**
+     * 简单 POST 请求
+     */
+    post<T = unknown>(url: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    /**
+     * 简单 PUT 请求
+     */
+    put<T = unknown>(url: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    /**
+     * 简单 DELETE 请求
+     */
+    delete<T = unknown>(url: string, options?: RequestOptions): Promise<T>;
+    /**
+     * 添加请求拦截器
+     */
+    addRequestInterceptor(interceptor: RequestInterceptor): void;
+    /**
+     * 添加响应拦截器
+     */
+    addResponseInterceptor(interceptor: ResponseInterceptor): void;
+    /**
+     * 添加错误拦截器
+     */
+    addErrorInterceptor(interceptor: ErrorInterceptor): void;
+    /**
+     * 获取缓存存储
+     */
+    getCacheStorage(): CacheStorage;
+    /**
+     * 清除缓存
+     */
+    clearCache(): void;
+    /**
+     * 删除特定缓存
+     */
+    invalidateCache(key: string): void;
+};
+declare const pluginDataFetch: _lytjs_core.PluginDefinition<unknown>;
+export { type CacheEntry, type CacheStorage, DefaultCacheStorage, type ErrorInterceptor, type FetchError, type FetchInstance, type FetchPluginOptions, type FetchState, type Interceptor, type RequestInterceptor, type RequestOptions, type ResponseInterceptor, createFetch, createFetchManager, pluginDataFetch as default, generateCacheKey };

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,196 @@
+import * as _lytjs_core from '@lytjs/core';
+/**
+ * @lytjs/plugin-data-fetch - 类型定义
+ */
+interface RequestOptions extends RequestInit {
+    /** 基础 URL */
+    baseUrl?: string;
+    /** 超时时间（毫秒） */
+    timeout?: number;
+    /** 重试次数 */
+    retries?: number;
+    /** 重试延迟（毫秒） */
+    retryDelay?: number;
+    /** 缓存策略 */
+    cacheStrategy?: 'no-cache' | 'cache-first' | 'network-first' | 'cache-only';
+    /** 缓存时间（毫秒） */
+    cacheTime?: number;
+    /** 请求标识，用于缓存键生成 */
+    requestKey?: string;
+    /** 是否取消重复请求 */
+    cancelDuplicate?: boolean;
+    /** 自定义错误处理 */
+    onError?: (error: FetchError) => void | Promise<void>;
+}
+interface FetchError extends Error {
+    /** HTTP 状态码 */
+    status?: number;
+    /** 原始响应 */
+    response?: Response;
+    /** 原始错误 */
+    originalError?: Error;
+    /** 请求配置 */
+    config?: RequestOptions;
+}
+interface CacheEntry<T = unknown> {
+    /** 缓存数据 */
+    data: T;
+    /** 过期时间 */
+    expiresAt: number;
+    /** 创建时间 */
+    createdAt: number;
+}
+interface CacheStorage {
+    /** 获取缓存 */
+    get<T = unknown>(key: string): CacheEntry<T> | null;
+    /** 设置缓存 */
+    set<T = unknown>(key: string, value: CacheEntry<T>): void;
+    /** 删除缓存 */
+    delete(key: string): void;
+    /** 清空缓存 */
+    clear(): void;
+    /** 检查缓存是否存在且有效 */
+    has(key: string): boolean;
+}
+interface Interceptor<T = unknown> {
+    /** 请求拦截器 */
+    request?: (config: RequestOptions) => RequestOptions | Promise<RequestOptions>;
+    /** 响应拦截器 */
+    response?: (response: T) => T | Promise<T>;
+    /** 错误拦截器 */
+    error?: (error: FetchError) => FetchError | Promise<FetchError>;
+}
+interface FetchState<T = unknown> {
+    /** 请求数据 */
+    data: T | null;
+    /** 加载状态 */
+    isLoading: boolean;
+    /** 错误状态 */
+    error: FetchError | null;
+    /** 是否已完成 */
+    isSuccess: boolean;
+    /** 是否失败 */
+    isError: boolean;
+    /** 请求次数 */
+    refetchCount: number;
+}
+interface FetchInstance<T = unknown> {
+    /** 当前状态 */
+    state: Readonly<FetchState<T>>;
+    /** 发起请求 */
+    fetch(): Promise<T>;
+    /** 重新请求 */
+    refetch(): Promise<T>;
+    /** 取消请求 */
+    cancel(): void;
+    /** 手动更新数据 */
+    setData(data: T | ((prev: T | null) => T)): void;
+    /** 手动更新错误 */
+    setError(error: FetchError | null): void;
+    /** 清空状态 */
+    reset(): void;
+}
+interface FetchPluginOptions {
+    /** 基础 URL */
+    baseUrl?: string;
+    /** 默认超时时间 */
+    timeout?: number;
+    /** 默认重试次数 */
+    retries?: number;
+    /** 默认重试延迟 */
+    retryDelay?: number;
+    /** 默认缓存策略 */
+    defaultCacheStrategy?: RequestOptions['cacheStrategy'];
+    /** 默认缓存时间 */
+    defaultCacheTime?: number;
+    /** 请求拦截器 */
+    requestInterceptors?: Interceptor['request'][];
+    /** 响应拦截器 */
+    responseInterceptors?: Interceptor['response'][];
+    /** 错误拦截器 */
+    errorInterceptors?: Interceptor['error'][];
+    /** 自定义缓存存储 */
+    cacheStorage?: CacheStorage;
+}
+interface RequestInterceptor {
+    (config: RequestOptions): RequestOptions | Promise<RequestOptions>;
+}
+interface ResponseInterceptor {
+    <T = unknown>(response: T): T | Promise<T>;
+}
+interface ErrorInterceptor {
+    (error: FetchError): FetchError | Promise<FetchError>;
+}
+/**
+ * 默认内存缓存实现
+ */
+declare class DefaultCacheStorage implements CacheStorage {
+    private cache;
+    get<T = unknown>(key: string): CacheEntry<T> | null;
+    set<T = unknown>(key: string, value: CacheEntry<T>): void;
+    delete(key: string): void;
+    clear(): void;
+    has(key: string): boolean;
+}
+/**
+ * 生成缓存键
+ */
+declare function generateCacheKey(url: string, options?: RequestOptions): string;
+/**
+ * 创建数据获取实例
+ */
+declare function createFetch<T = unknown>(url: string, options?: RequestOptions, globalOptions?: FetchPluginOptions): FetchInstance<T>;
+/**
+ * 创建 Fetch 管理器
+ */
+declare function createFetchManager(globalOptions?: FetchPluginOptions): {
+    /**
+     * 创建 Fetch 实例
+     */
+    createFetch<T = unknown>(url: string, options?: RequestOptions): FetchInstance<T>;
+    /**
+     * 简单 GET 请求
+     */
+    get<T = unknown>(url: string, options?: RequestOptions): Promise<T>;
+    /**
+     * 简单 POST 请求
+     */
+    post<T = unknown>(url: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    /**
+     * 简单 PUT 请求
+     */
+    put<T = unknown>(url: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    /**
+     * 简单 DELETE 请求
+     */
+    delete<T = unknown>(url: string, options?: RequestOptions): Promise<T>;
+    /**
+     * 添加请求拦截器
+     */
+    addRequestInterceptor(interceptor: RequestInterceptor): void;
+    /**
+     * 添加响应拦截器
+     */
+    addResponseInterceptor(interceptor: ResponseInterceptor): void;
+    /**
+     * 添加错误拦截器
+     */
+    addErrorInterceptor(interceptor: ErrorInterceptor): void;
+    /**
+     * 获取缓存存储
+     */
+    getCacheStorage(): CacheStorage;
+    /**
+     * 清除缓存
+     */
+    clearCache(): void;
+    /**
+     * 删除特定缓存
+     */
+    invalidateCache(key: string): void;
+};
+declare const pluginDataFetch: _lytjs_core.PluginDefinition<unknown>;
+export { type CacheEntry, type CacheStorage, DefaultCacheStorage, type ErrorInterceptor, type FetchError, type FetchInstance, type FetchPluginOptions, type FetchState, type Interceptor, type RequestInterceptor, type RequestOptions, type ResponseInterceptor, createFetch, createFetchManager, pluginDataFetch as default, generateCacheKey };

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@lytjs/plugin-data-fetch",
-  "version": "6.7.0",
+  "version": "6.9.0",
   "description": "LytJS official data fetch plugin with caching, retries, and interceptors",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -29,8 +29,8 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@lytjs/core": "^6.7.0",
-    "@lytjs/reactivity": "^6.7.0"
+    "@lytjs/core": "^6.9.0",
+    "@lytjs/reactivity": "^6.9.0"
   },
   "devDependencies": {
     "tsup": "^8.0.0",