zcw-shared 1.2.0

package/types/network.d.ts

@@ -0,0 +1,184 @@
+/**
+ * 网络请求相关类型定义
+ * 
+ * @description
+ * 定义网络请求hooks使用的接口和类型
+ * 
+ * @since 1.0.0
+ * @author Assistant
+ */
+
+import type { Response } from '../../references/fetch.d'
+
+/**
+ * 请求选项接口
+ */
+export interface RequestOptions extends RequestInit {
+  /** 是否启用缓存 */
+  cache?: boolean
+  /** 缓存TTL（毫秒） */
+  cacheTTL?: number
+  /** 重试次数 */
+  retry?: number
+  /** 重试延迟（毫秒） */
+  retryDelay?: number
+  /** 请求超时（毫秒） */
+  timeout?: number
+}
+
+/**
+ * 请求结果接口
+ */
+export interface RequestResult<T> {
+  /** 请求是否成功 */
+  success: boolean
+  /** 响应数据 */
+  data: T | null
+  /** 错误信息 */
+  error: Error | null
+  /** 是否来自缓存 */
+  fromCache: boolean
+}
+
+/**
+ * 响应式值接口
+ */
+export interface ReactiveValue<T> {
+  value: T
+}
+
+/**
+ * useRequest返回值接口
+ */
+export interface UseRequestReturn<T> {
+  /** 加载状态 */
+  loading: ReactiveValue<boolean>
+  /** 错误状态 */
+  error: ReactiveValue<Error | null>
+  /** 数据状态 */
+  data: ReactiveValue<T | null>
+  /** 执行请求 */
+  execute: (url: string, options?: RequestOptions) => Promise<RequestResult<T>>
+  /** 取消请求 */
+  cancel: () => void
+  /** 清除缓存 */
+  clearCache: (url?: string) => void
+  /** 获取缓存统计 */
+  getCacheStats: () => {
+    total: number
+    valid: number
+    expired: number
+  }
+}
+
+/**
+ * 请求数据类型
+ */
+export type RequestData = string | FormData | Blob | ArrayBuffer | URLSearchParams | Record<string, unknown> | null
+
+/**
+ * Fetch选项接口
+ */
+export interface FetchOptions {
+  /** 基础URL */
+  baseURL?: string
+  /** 请求数据 */
+  data?: RequestData
+  /** HTTP方法 */
+  method?: string
+  /** 请求头 */
+  headers?: Record<string, string> | Headers
+  /** 请求体 */
+  body?: BodyInit | null
+  /** 中止信号 */
+  signal?: AbortSignal
+  /** 凭据模式 */
+  credentials?: RequestCredentials
+  /** 缓存模式 */
+  cache?: RequestCache
+  /** 重定向模式 */
+  redirect?: RequestRedirect
+  /** 引用者 */
+  referrer?: string
+  /** 引用者策略 */
+  referrerPolicy?: ReferrerPolicy
+  /** 完整性 */
+  integrity?: string
+  /** 保持连接 */
+  keepalive?: boolean
+  /** 模式 */
+  mode?: RequestMode
+}
+
+/**
+ * Fetch结果接口
+ */
+export interface FetchResult<T> {
+  /** 请求是否成功 */
+  success: boolean
+  /** 响应数据 */
+  data: T | null
+  /** 响应数据 */
+  response: Response | null
+  /** 错误信息 */
+  error: Error | null
+}
+
+/**
+ * useFetch返回值接口
+ */
+export interface UseFetchReturn {
+  /** 加载状态 */
+  loading: ReactiveValue<boolean>
+  /** 错误状态 */
+  error: ReactiveValue<Error | null>
+  /** 通用请求方法 */
+  request: <T>(url: string, options?: FetchOptions) => Promise<FetchResult<T>>
+  /** GET请求 */
+  get: <T>(url: string, options?: Omit<FetchOptions, 'method' | 'data'>) => Promise<FetchResult<T>>
+  /** POST请求 */
+  post: <T>(url: string, data?: RequestData, options?: Omit<FetchOptions, 'method' | 'data'>) => Promise<FetchResult<T>>
+  /** PUT请求 */
+  put: <T>(url: string, data?: RequestData, options?: Omit<FetchOptions, 'method' | 'data'>) => Promise<FetchResult<T>>
+  /** DELETE请求 */
+  delete: <T>(url: string, options?: Omit<FetchOptions, 'method' | 'data'>) => Promise<FetchResult<T>>
+  /** PATCH请求 */
+  patch: <T>(url: string, data?: RequestData, options?: Omit<FetchOptions, 'method' | 'data'>) => Promise<FetchResult<T>>
+  /** HEAD请求 */
+  head: (url: string, options?: Omit<FetchOptions, 'method' | 'data'>) => Promise<FetchResult<unknown>>
+  /** OPTIONS请求 */
+  options: (url: string, options?: Omit<FetchOptions, 'method' | 'data'>) => Promise<FetchResult<unknown>>
+  /** 添加请求拦截器 */
+  addRequestInterceptor: (interceptor: (config: FetchOptions) => FetchOptions | Promise<FetchOptions>) => void
+  /** 添加响应拦截器 */
+  addResponseInterceptor: (interceptor: (response: Response) => Response | Promise<Response>) => void
+  /** 移除请求拦截器 */
+  removeRequestInterceptor: (interceptor: (config: FetchOptions) => FetchOptions | Promise<FetchOptions>) => void
+  /** 移除响应拦截器 */
+  removeResponseInterceptor: (interceptor: (response: Response) => Response | Promise<Response>) => void
+}
+
+/**
+ * 请求拦截器函数类型
+ */
+export type RequestInterceptor = (config: FetchOptions) => FetchOptions | Promise<FetchOptions>
+
+/**
+ * 响应拦截器类型
+ */
+export type ResponseInterceptor = (response: Response) => Response | Promise<Response>
+
+/**
+ * HTTP方法类型
+ */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS'
+
+/**
+ * 缓存策略类型
+ */
+export type CacheStrategy = 'no-cache' | 'memory' | 'storage'
+
+/**
+ * 请求状态类型
+ */
+export type RequestStatus = 'idle' | 'loading' | 'success' | 'error'

package/types/storage.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 存储相关的应用层类型定义
+ * 
+ * @description
+ * 定义存储hooks使用的接口和类型，不包含环境相关的类型
+ * 环境相关的类型请从 references/storage.d 导入
+ * 
+ * @since 1.0.0
+ * @author Assistant
+ */
+
+// 存储操作结果
+export interface StorageResult<T> {
+  success: boolean
+  data?: T
+  error?: string
+}
+
+// 存储配置选项
+export interface StorageOptions {
+  prefix?: string // 键名前缀
+  serializer?: {
+    serialize: (value: any) => string
+    deserialize: (value: string) => any
+  }
+}
+
+// IndexedDB 存储配置
+export interface IndexedDBStorageOptions extends StorageOptions {
+  dbName: string // 数据库名称
+  storeName: string // 对象存储名称
+  version?: number // 数据库版本
+}
+
+// 存储 Hook 返回值接口
+export interface UseStorageReturn<T> {
+  value: T | null
+  setValue: (value: T | null) => Promise<void>
+  removeValue: () => Promise<void>
+  clear: () => Promise<void>
+}
+
+// 存储适配器接口
+export interface StorageAdapter<T> {
+  get: (key: string) => Promise<T | null>
+  set: (key: string, value: T) => Promise<void>
+  remove: (key: string) => Promise<void>
+  clear: () => Promise<void>
+}

package/types/util.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 通用工具类型定义
+ */
+
+// 忽略所有body开头的属性
+export type OmitBodyProperties<T> = {
+  [K in keyof T as K extends `body${string}` ? never : K]: T[K]
+}
+
+// 深度可选类型
+export type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P]
+}
+
+// 可选属性类型
+export type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
+
+// 必需属性类型
+export type RequiredKeys<T, K extends keyof T> = T & Required<Pick<T, K>>
+
+// 非空类型
+export type NonNullable<T> = T extends null | undefined ? never : T
+
+// 键值对类型
+export type KeyValuePair<K extends string | number | symbol, V> = {
+  [P in K]: V
+}

package/types/wasm.d.ts

@@ -0,0 +1,217 @@
+/**
+ * WebAssembly 相关的应用层类型定义
+ * 
+ * @description
+ * 定义 WASM hooks 使用的接口和类型，不包含环境相关的类型
+ * 环境相关的类型请从 references/webassembly.d 导入
+ * 
+ * @since 1.0.0
+ * @author Assistant
+ */
+
+import { WebAssembly } from '../../references/webassembly.d'
+
+/**
+ * 响应式值接口
+ */
+export interface ReactiveValue<T> {
+  value: T
+  subscribe: (callback: (value: T) => void) => () => void
+}
+
+/**
+ * WASM模块信息
+ */
+export interface WASMModule {
+  /** 编译后的WASM模块 */
+  module: WebAssembly.Module
+  /** 模块大小（字节） */
+  size: number
+  /** 导出的函数名列表 */
+  exports: string[]
+}
+
+/**
+ * WASM内存管理
+ */
+export interface WASMMemory {
+  /** 内存缓冲区 */
+  buffer: ArrayBuffer
+  /** 内存页数 */
+  pages: number
+  /** 扩展内存 */
+  grow: (pages: number) => number
+}
+
+/**
+ * WASM函数包装器
+ */
+export interface WASMFunction {
+  /** 函数名 */
+  name: string
+  /** 调用函数 */
+  call: (...args: any[]) => any
+  /** 原始函数 */
+  original: Function
+}
+
+/**
+ * WASM导入对象
+ */
+export interface WASMImports {
+  /** 环境导入 */
+  env?: {
+    /** 内存对象 */
+    memory?: WebAssembly.Memory
+    /** 其他环境函数 */
+    [key: string]: any
+  }
+  /** 其他模块导入 */
+  [module: string]: any
+}
+
+/**
+ * WASM配置选项
+ */
+export interface WASMOptions {
+  /** WASM文件URL */
+  url?: string
+  /** WASM字节数组 */
+  bytes?: ArrayBuffer
+  /** 是否自动加载 */
+  autoLoad?: boolean
+  /** 初始内存页数 */
+  memoryPages?: number
+  /** 最大内存页数 */
+  maxMemoryPages?: number
+  /** 导入对象 */
+  imports?: WASMImports
+  /** 超时时间（毫秒） */
+  timeout?: number
+  /** 重试次数 */
+  retries?: number
+  /** 重试延迟（毫秒） */
+  retryDelay?: number
+}
+
+/**
+ * WASM操作结果
+ */
+export interface WASMResult {
+  /** 是否成功 */
+  success: boolean
+  /** 模块信息（成功时） */
+  module?: WASMModule
+  /** 实例对象（成功时） */
+  instance?: WebAssembly.Instance
+  /** 内存对象（成功时） */
+  memory?: WASMMemory
+  /** 导出函数（成功时） */
+  exports?: Record<string, WASMFunction>
+  /** 错误信息（失败时） */
+  error?: Error
+}
+
+/**
+ * WASM Hook返回值
+ */
+export interface UseWASMReturn {
+  /** 是否正在加载 */
+  isLoading: ReactiveValue<boolean>
+  /** 是否已准备就绪 */
+  isReady: ReactiveValue<boolean>
+  /** 错误信息 */
+  error: ReactiveValue<Error | null>
+  /** 模块信息 */
+  module: ReactiveValue<WASMModule | null>
+  /** 实例对象 */
+  instance: ReactiveValue<WebAssembly.Instance | null>
+  /** 内存对象 */
+  memory: ReactiveValue<WASMMemory | null>
+  /** 导出函数 */
+  exports: ReactiveValue<Record<string, WASMFunction> | null>
+
+  /** 加载WASM模块 */
+  load: () => Promise<WASMResult>
+  /** 调用WASM函数 */
+  callFunction: <T>(functionName: string, ...args: any[]) => T
+  /** 读取内存数据 */
+  readMemory: (
+    offset: number,
+    length: number,
+    type?: 'uint8' | 'uint16' | 'uint32' | 'int8' | 'int16' | 'int32' | 'float32' | 'float64'
+  ) => number[]
+  /** 写入内存数据 */
+  writeMemory: (
+    offset: number,
+    data: number[],
+    type?: 'uint8' | 'uint16' | 'uint32' | 'int8' | 'int16' | 'int32' | 'float32' | 'float64'
+  ) => void
+  /** 分配内存 */
+  allocateMemory: (size: number) => number
+  /** 释放内存 */
+  freeMemory: (pointer: number) => void
+  /** 重置模块 */
+  reset: () => void
+  /** 获取模块信息 */
+  getModuleInfo: () => {
+    module: WebAssembly.Module
+    instance: WebAssembly.Instance
+    memory: WebAssembly.Memory | null
+    exports: string[]
+    memorySize: number
+    memoryPages: number
+  } | null
+}
+
+/**
+ * 内存类型
+ */
+export type MemoryType = 'uint8' | 'uint16' | 'uint32' | 'int8' | 'int16' | 'int32' | 'float32' | 'float64'
+
+/**
+ * WASM模块状态
+ */
+export type WASMStatus = 'idle' | 'loading' | 'ready' | 'error'
+
+/**
+ * WASM错误类型
+ */
+export interface WASMError extends Error {
+  /** 错误类型 */
+  type: 'compile' | 'instantiate' | 'runtime' | 'memory' | 'function'
+  /** 错误详情 */
+  details?: any
+}
+
+/**
+ * WASM性能指标
+ */
+export interface WASMPerformance {
+  /** 编译时间（毫秒） */
+  compileTime: number
+  /** 实例化时间（毫秒） */
+  instantiateTime: number
+  /** 总加载时间（毫秒） */
+  loadTime: number
+  /** 模块大小（字节） */
+  moduleSize: number
+  /** 内存使用量（字节） */
+  memoryUsage: number
+}
+
+/**
+ * WASM调试信息
+ */
+export interface WASMDebugInfo {
+  /** 模块名称 */
+  moduleName?: string
+  /** 版本信息 */
+  version?: string
+  /** 编译器信息 */
+  compiler?: string
+  /** 源语言 */
+  sourceLanguage?: string
+  /** 调试符号 */
+  debugSymbols?: boolean
+}