@reskin/core 0.0.21 → 0.1.0

package/interceptors/error.interceptor.d.ts

@@ -1,19 +1,60 @@
 import { HttpRequest, HttpHandler, HttpEvent, HttpInterceptor } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { Router } from '@angular/router';
+import { ErrorInterceptorConfig } from './types';
 import * as i0 from "@angular/core";
+/**
+ * HTTP 错误拦截器
+ * 统一处理 HTTP 请求错误，包括 401 未授权错误的自动跳转
+ */
 export declare class ErrorInterceptor implements HttpInterceptor {
     private router;
+    private config;
     constructor(router: Router);
+    /**
+     * 设置拦截器配置
+     * @param config 配置对象
+     */
+    setConfig(config: ErrorInterceptorConfig): void;
+    /**
+     * 拦截 HTTP 请求，处理错误响应
+     * @param request HTTP 请求对象
+     * @param next 下一个拦截器处理器
+     * @returns Observable<HttpEvent<unknown>>
+     */
     intercept(request: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>>;
+    /**
+     * 处理 401 未授权错误
+     */
+    private handleUnauthorizedError;
+    /**
+     * 提取错误信息
+     * @param error HTTP 错误响应
+     * @returns 错误信息字符串
+     */
+    private extractErrorMessage;
     static ɵfac: i0.ɵɵFactoryDeclaration<ErrorInterceptor, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ErrorInterceptor>;
 }
 /**
- * 请求错误拦截器
+ * 提供 HTTP 错误拦截器
+ * @param config 可选的配置对象
+ * @returns Provider 配置对象
+ * @example
+ * providers: [
+ *   providerHttpError({ unauthorizedPath: '/login', enableLogging: true })
+ * ]
  */
-export declare function providerHttpError(): {
+export declare function providerHttpError(config?: ErrorInterceptorConfig): {
+    provide: import("@angular/core").InjectionToken<HttpInterceptor[]>;
+    useFactory: (router: Router) => ErrorInterceptor;
+    deps: (typeof Router)[];
+    multi: boolean;
+    useClass?: undefined;
+} | {
     provide: import("@angular/core").InjectionToken<HttpInterceptor[]>;
     useClass: typeof ErrorInterceptor;
     multi: boolean;
+    useFactory?: undefined;
+    deps?: undefined;
 };

package/interceptors/public-api.d.ts

@@ -1,3 +1,4 @@
+export * from './types';
 export * from './token.interceptor';
 export * from './error.interceptor';
 export * from './cache.interceptor';

package/interceptors/token.interceptor.d.ts

@@ -2,15 +2,26 @@ import { HttpRequest, HttpHandler, HttpEvent, HttpInterceptor, HttpHeaders } fro
 import { Observable } from 'rxjs';
 import { RkAuthService } from '@reskin/core/services';
 import * as i0 from "@angular/core";
+/**
+ * Token 拦截器
+ * 自动为 HTTP 请求添加认证 Token
+ */
 export declare class TokenInterceptor implements HttpInterceptor {
-    private service;
-    constructor(service: RkAuthService);
+    private authService;
+    constructor(authService: RkAuthService);
+    /**
+     * 拦截 HTTP 请求，添加 Token 认证信息
+     * @param request HTTP 请求对象
+     * @param next 下一个拦截器处理器
+     * @returns Observable<HttpEvent<unknown>>
+     */
     intercept(request: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<TokenInterceptor, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<TokenInterceptor>;
 }
 /**
- * 请求头增加token验证拦截器
+ * 提供 Token 拦截器
+ * @returns Provider 配置对象
  */
 export declare function providerAuthToken(): {
     provide: import("@angular/core").InjectionToken<HttpInterceptor[]>;
@@ -18,20 +29,38 @@ export declare function providerAuthToken(): {
     multi: boolean;
 };
 /**
- * 不带token验证信息请求
- * @param urls 地址
- * @param params 参数
- * @constructor
+ * 创建不带 Token 的请求配置
+ * @param urls 模板字符串数组
+ * @param params 模板参数
+ * @returns [url, options] 元组
+ * @example
+ * this.http.get(...NoAuthTokenTemplate`/api/public/data`).subscribe();
  */
 export declare function NoAuthTokenTemplate(urls: TemplateStringsArray, ...params: any[]): [string, {
     headers: HttpHeaders;
 }];
 /**
- * 使用自定义token的请求(模板字符串版本)
- * @param urls 地址
- * @param params 参数，第一个参数必须是token值
- * @constructor
+ * 创建使用自定义 Token 的请求配置
+ * @param token 自定义 Token 值
+ * @param urls 模板字符串数组
+ * @param params 模板参数
+ * @returns [url, options] 元组
+ * @example
+ * this.http.get(...CustomTokenTemplate('my-token', `/api/data`)).subscribe();
+ */
+export declare function CustomTokenTemplate(token: string, urls: TemplateStringsArray, ...params: any[]): [string, {
+    headers: HttpHeaders;
+}];
+/**
+ * 创建使用自定义 Token 和自定义 Header 名称的请求配置
+ * @param token 自定义 Token 值
+ * @param headerName 自定义 Header 名称
+ * @param urls 模板字符串数组
+ * @param params 模板参数
+ * @returns [url, options] 元组
+ * @example
+ * this.http.get(...CustomTokenWithHeaderTemplate('my-token', 'X-API-Key', `/api/data`)).subscribe();
  */
-export declare function CustomTokenTemplate(urls: TemplateStringsArray, ...params: any[]): [string, {
+export declare function CustomTokenWithHeaderTemplate(token: string, headerName: string, urls: TemplateStringsArray, ...params: any[]): [string, {
     headers: HttpHeaders;
 }];

package/interceptors/types.d.ts

@@ -0,0 +1,68 @@
+/**
+ * HTTP 拦截器相关类型定义
+ */
+/**
+ * Token 拦截器配置
+ */
+export interface TokenInterceptorConfig {
+    /**
+     * 默认的 Token Header 名称
+     * @default 'Authorization'
+     */
+    tokenHeaderName?: string;
+    /**
+     * 认证 ID Header 名称
+     * @default 'X-Auth-Id'
+     */
+    authIdHeaderName?: string;
+}
+/**
+ * 错误拦截器配置
+ */
+export interface ErrorInterceptorConfig {
+    /**
+     * 401 错误跳转路径
+     * @default '/errors/401'
+     */
+    unauthorizedPath?: string;
+    /**
+     * 是否启用错误日志
+     * @default false
+     */
+    enableLogging?: boolean;
+    /**
+     * 自定义错误处理函数
+     */
+    customErrorHandler?: (error: any) => void;
+}
+/**
+ * 缓存拦截器配置
+ */
+export interface CacheInterceptorConfig {
+    /**
+     * 缓存最大数量
+     * @default 100
+     */
+    maxCacheSize?: number;
+    /**
+     * 缓存过期时间（毫秒）
+     * @default undefined (永不过期)
+     */
+    cacheExpiration?: number;
+}
+/**
+ * HTTP 请求选项扩展
+ */
+export interface HttpRequestOptions {
+    headers?: {
+        [name: string]: string | string[];
+    };
+}
+/**
+ * Token 控制类型
+ */
+export declare type TokenControl = 'no-token' | 'custom-token';
+/**
+ * 缓存策略类型
+ */
+export declare type CacheStrategy = 'Storage' | 'Memory';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reskin/core",
-  "version": "0.0.21",
+  "version": "0.1.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"

package/utils/array.d.ts

@@ -1,9 +1,16 @@
 /**
  * 深克隆一个对象或数组
  *
- * 该函数通过递归方式深克隆输入的对象或数组，确保与原对象或数组隔离，不会相互影响
+ * 该函数通过递归方式深克隆输入的对象或数组，确保与原对象或数组隔离，不会相互影响。
+ * 支持克隆：普通对象、数组、Date、Map、Set、RegExp 等类型。
  *
  * @param source 需要克隆的源对象或数组
  * @returns 返回克隆后的对象或数组
+ *
+ * @example
+ * const obj = { a: 1, b: { c: 2 } };
+ * const cloned = deepClone(obj);
+ * cloned.b.c = 3;
+ * console.log(obj.b.c); // 输出: 2
  */
 export declare function deepClone<T>(source: T): T;

package/utils/dom.d.ts

@@ -1,11 +1,38 @@
 import { Observable } from 'rxjs';
+/**
+ * 监听元素大小变化的配置选项
+ */
+export interface ObserveResizeOptions {
+    /**
+     * 防抖延迟时间（毫秒）
+     * 设置后会对频繁的大小变化事件进行防抖处理
+     * @default undefined (不防抖)
+     */
+    debounce?: number;
+}
 /**
  * 监听元素的大小变化
  *
- * 此函数创建了一个Observable，用于观察给定HTMLElement元素的大小变化它使用了ResizeObserver API来实现
- * 当元素的大小发生变化时，会发出一个包含变化记录的数组
+ * 此函数创建了一个 Observable，用于观察给定 HTMLElement 元素的大小变化。
+ * 它使用了 ResizeObserver API 来实现，当元素的大小发生变化时，会发出一个包含变化记录的数组。
+ *
+ * @param element 需要观察大小变化的 HTMLElement 元素
+ * @param options 配置选项
+ * @returns 返回一个 Observable，其中包含 ResizeObserverEntry 的数组，用于记录每次大小变化的信息
+ *
+ * @example
+ * // 基础用法
+ * const element = document.querySelector('.container');
+ * observeResize(element).subscribe(entries => {
+ *   const { width, height } = entries[0].contentRect;
+ *   console.log(`元素尺寸: ${width}x${height}`);
+ * });
  *
- * @param element 需要观察大小变化的HTMLElement元素
- * @returns 返回一个Observable，其中包含ResizeObserverEntry的数组，用于记录每次大小变化的信息
+ * @example
+ * // 使用防抖优化性能
+ * observeResize(element, { debounce: 300 }).subscribe(entries => {
+ *   // 300ms 内的多次变化只会触发一次
+ *   console.log('元素大小已稳定');
+ * });
  */
-export declare function observeResize(element: HTMLElement): Observable<ResizeObserverEntry[]>;
+export declare function observeResize(element: HTMLElement, options?: ObserveResizeOptions): Observable<ResizeObserverEntry[]>;

package/utils/form.d.ts

@@ -1,6 +1,41 @@
 import { FormGroup } from '@angular/forms';
+/**
+ * 表单验证配置
+ */
+export interface FormVerifyOptions {
+    /**
+     * 是否在控制台输出错误信息
+     * @default true
+     */
+    logError?: boolean;
+    /**
+     * 自定义错误处理函数
+     */
+    onError?: (invalidFields: string[]) => void;
+}
 /**
  * 表单验证
- * @param form
+ *
+ * 遍历表单所有控件，标记为脏状态并触发验证。
+ * 如果表单验证通过，返回表单的原始值；否则返回 false。
+ *
+ * @param form Angular 表单组对象
+ * @param options 验证配置选项
+ * @returns 验证通过返回表单值，验证失败返回 false
+ *
+ * @example
+ * const result = formVerify(this.form);
+ * if (result) {
+ *   console.log('表单数据:', result);
+ * }
+ *
+ * @example
+ * // 自定义错误处理
+ * formVerify(this.form, {
+ *   logError: false,
+ *   onError: (fields) => {
+ *     this.message.error(`以下字段验证失败: ${fields.join(', ')}`);
+ *   }
+ * });
  */
-export declare function formVerify<T = Record<string, any>>(form: FormGroup): false | T;
+export declare function formVerify<T = Record<string, any>>(form: FormGroup, options?: FormVerifyOptions): false | T;

package/utils/store.d.ts

@@ -4,10 +4,12 @@
 export interface StoreOptions {
     /**
      * 缓存存储方式
+     * @default sessionStorage
      */
     storageEngine?: Storage;
     /**
-     * 过期时间(毫秒)
+     * 过期时间（毫秒）
+     * @default undefined (永不过期)
      */
     expires?: number;
 }
@@ -15,40 +17,79 @@ export interface StoreOptions {
  * 设置存储前缀
  *
  * 该函数用于更改全局存储前缀，影响后续所有存储操作的键名前缀。
- * 存储前缀的更改可能会影响已存储的数据被正确识别和访问。
+ * 注意：更改前缀后，之前使用旧前缀存储的数据将无法访问。
  *
  * @param newPrefix 新的存储前缀字符串
+ *
+ * @example
+ * setStorePrefix('MY_APP_');
  */
 export declare function setStorePrefix(newPrefix: string): void;
 /**
- * 提供了一个用于缓存值的类，值可以被存储在浏览器的localStorage或sessionStorage中。
- * 如果提供了过期时间，存储的值会在过期后自动移除。
+ * 提供了一个用于缓存值的类，值可以被存储在浏览器的 localStorage 或 sessionStorage 中。
+ * 支持过期时间设置，过期后数据会自动移除。
+ *
+ * @template T 存储数据的类型
+ *
+ * @example
+ * // 基础用法
+ * const userStore = new Store<User>('user', { name: '', age: 0 });
+ * userStore.set({ name: '张三', age: 25 });
+ * console.log(userStore.get()); // { name: '张三', age: 25 }
+ *
+ * @example
+ * // 使用 localStorage 并设置过期时间
+ * const tokenStore = new Store<string>('token', '', {
+ *   storageEngine: localStorage,
+ *   expires: 3600000 // 1小时后过期
+ * });
  */
 export declare class Store<T> {
     private value;
     private readonly storage;
     private readonly expires?;
-    private readonly storageKey;
+    private readonly key;
     /**
-     * 初始化Store类的实例。
-     * @param key 缓存值的键名。
-     * @param defaultValue 初始值，默认值会被存储并返回直到设置新的值。
-     * @param options 配置选项，包括存储引擎和过期时间。
+     * 初始化 Store 类的实例
+     * @param key 缓存值的键名
+     * @param defaultValue 初始值，默认值会被存储并返回直到设置新的值
+     * @param options 配置选项，包括存储引擎和过期时间
      */
     constructor(key: string, defaultValue: T, options?: StoreOptions);
     /**
-     * 获取当前缓存的值。
-     * @returns 缓存的值。
+     * 生成存储键名
+     */
+    private getStorageKey;
+    /**
+     * 从存储中加载数据
+     */
+    private loadFromStorage;
+    /**
+     * 获取当前缓存的值
+     * @returns 缓存的值
      */
     get(): T;
     /**
-     * 设置新的缓存值。
-     * @param newValue 新的值。
+     * 设置新的缓存值
+     * @param newValue 新的值
      */
     set(newValue: T): void;
     /**
-     * 使用提供的函数更新缓存的值。
-     * @param updateFn 一个接受当前值并返回新值的函数。
+     * 使用提供的函数更新缓存的值
+     * @param updateFn 一个接受当前值并返回新值的函数
+     *
+     * @example
+     * const countStore = new Store<number>('count', 0);
+     * countStore.update(count => count + 1);
      */
     update(updateFn: (currentValue: T) => T): void;
+    /**
+     * 清除缓存数据
+     */
+    clear(): void;
+    /**
+     * 检查缓存是否存在且未过期
+     * @returns 如果缓存存在且未过期返回 true，否则返回 false
+     */
+    has(): boolean;
 }