@composy/store-core 0.0.1 → 0.0.2

package/esm/types/store.d.ts

@@ -1,198 +0,0 @@
-/**
- * Store 核心类型定义
- *
- * @module types/store
- */
-/**
- * 状态对象类型
- */
-export type StateTree = Record<string | number | symbol, unknown>;
-/**
- * Store ID 类型
- */
-export type StoreId = string;
-/**
- * Getter 函数类型
- * @template S - 状态类型
- * @template R - 返回值类型
- */
-export type StoreGetter<S extends StateTree, R> = (state: S) => R;
-/**
- * Getter 集合类型
- * @template S - 状态类型
- */
-export type StoreGetters<S extends StateTree> = Record<string, StoreGetter<S, unknown>>;
-/**
- * Action 函数类型
- *
- * 允许 action 通过 `this` 访问当前 Store 实例；未使用 `this` 的普通函数依旧兼容。
- */
-export type StoreAction = (...args: unknown[]) => unknown;
-/**
- * Action 集合类型
- */
-export type StoreActions = Record<string, StoreAction>;
-/**
- * Store 定义选项
- * @template Id - Store ID 类型
- * @template S - 状态类型
- * @template G - Getters 类型
- * @template A - Actions 类型
- */
-export interface StoreDefinition<Id extends StoreId = StoreId, S extends StateTree = StateTree, G extends StoreGetters<S> = StoreGetters<S>, A extends StoreActions = StoreActions> {
-    /** Store 唯一标识 */
-    id: Id;
-    /** 初始状态工厂函数 */
-    state: () => S;
-    /** Getters 定义 */
-    getters?: G;
-    /** Actions 定义 */
-    actions?: A;
-}
-/**
- * Store 实例接口
- * @template Id - Store ID 类型
- * @template S - 状态类型
- * @template G - Getters 类型
- * @template A - Actions 类型
- */
-export interface StoreInstance<Id extends StoreId = StoreId, S extends StateTree = StateTree, G extends StoreGetters<S> = StoreGetters<S>, A extends StoreActions = StoreActions> {
-    /** Store 唯一标识 */
-    $id: Id;
-    /** 当前状态 */
-    $state: S;
-    /** Getter 计算结果 */
-    getters: {
-        [K in keyof G]: ReturnType<G[K]>;
-    };
-    /** Action 方法集合 */
-    actions: A;
-    /**
-     * 重置状态到初始值
-     */
-    $reset: () => void;
-    /**
-     * 批量更新状态
-     * @param partialState - 部分状态或更新函数
-     */
-    $patch: (partialState: Partial<S> | ((state: S) => void)) => void;
-    /**
-     * 订阅状态变化
-     * @param callback - 回调函数
-     * @param options - 订阅选项
-     * @returns 取消订阅函数
-     */
-    $subscribe: (callback: StateSubscriber<S>, options?: SubscribeOptions) => () => void;
-    /**
-     * 订阅 action 调用
-     * @param callback - 回调函数
-     * @returns 取消订阅函数
-     */
-    $onAction: (callback: ActionSubscriber<A>) => () => void;
-    /**
-     * 销毁 store
-     */
-    $dispose: () => void;
-}
-/**
- * 状态变化订阅器
- * @template S - 状态类型
- */
-export type StateSubscriber<S extends StateTree> = (mutation: StateMutation<S>, state: S) => void;
-/**
- * 状态变化信息
- * @template S - 状态类型
- */
-export interface StateMutation<S extends StateTree> {
-    /** 变化类型 */
-    type: 'direct' | 'patch object' | 'patch function';
-    /** Store ID */
-    storeId: StoreId;
-    /** 变化的键路径 */
-    events?: string[];
-    /** 变化前的状态快照 */
-    oldState?: Partial<S>;
-}
-/**
- * 订阅选项
- */
-export interface SubscribeOptions {
-    /** 是否立即执行一次 */
-    immediate?: boolean;
-    /** 是否深度监听 */
-    deep?: boolean;
-    /** 是否在组件卸载后继续监听 */
-    detached?: boolean;
-}
-/**
- * Action 订阅器
- * @template A - Actions 类型
- */
-export type ActionSubscriber<A extends StoreActions> = (context: ActionContext<A>) => void;
-/**
- * Action 上下文
- * @template A - Actions 类型
- */
-export interface ActionContext<A extends StoreActions> {
-    /** Action 名称 */
-    name: keyof A;
-    /** Store ID */
-    storeId: StoreId;
-    /** 调用参数 */
-    args: unknown[];
-    /** 执行后回调，异步 action 会在 Promise resolve 后触发 */
-    after: (callback: (result: unknown) => void | Promise<void>) => void;
-    /** 错误回调，异步 action 会在 Promise reject 后触发 */
-    onError: (callback: (error: unknown) => void | Promise<void>) => void;
-}
-/**
- * Store 配置选项
- */
-export interface StoreOptions {
-    /** 是否启用严格模式（只能通过 action 修改状态） */
-    strict?: boolean;
-    /** 是否启用开发工具 */
-    devtools?: boolean;
-    /** 是否启用持久化 */
-    persist?: boolean;
-    /** 持久化配置 */
-    persistOptions?: PersistOptions;
-}
-/**
- * 持久化选项
- */
-export interface PersistOptions {
-    /** 存储键名 */
-    key?: string;
-    /** 存储类型 */
-    storage?: 'localStorage' | 'sessionStorage' | 'custom';
-    /** 自定义存储适配器 */
-    customStorage?: StorageAdapter;
-    /** 要持久化的路径 */
-    paths?: string[];
-    /** 序列化函数 */
-    serializer?: {
-        serialize: (value: unknown) => string;
-        deserialize: (value: string) => unknown;
-    };
-    /** 恢复前回调 */
-    beforeRestore?: (context: {
-        store: unknown;
-    }) => void;
-    /** 恢复后回调 */
-    afterRestore?: (context: {
-        store: unknown;
-    }) => void;
-}
-/**
- * 存储适配器接口
- */
-export interface StorageAdapter {
-    /** 获取数据 */
-    getItem: (key: string) => string | null | Promise<string | null>;
-    /** 设置数据 */
-    setItem: (key: string, value: string) => void | Promise<void>;
-    /** 删除数据 */
-    removeItem: (key: string) => void | Promise<void>;
-}
-//# sourceMappingURL=store.d.ts.map

package/esm/types/subscription.d.ts

@@ -1,158 +0,0 @@
-/**
- * 订阅系统类型定义
- *
- * @module types/subscription
- */
-import type { StateTree, StoreId } from './store';
-/**
- * 订阅回调类型
- * @template T - 数据类型
- */
-export type Subscriber<T = unknown> = (value: T, oldValue?: T) => void;
-/**
- * 取消订阅函数类型
- */
-export type Unsubscribe = () => void;
-/**
- * 订阅选项
- */
-export interface SubscriptionOptions {
-    /** 是否立即执行 */
-    immediate?: boolean;
-    /** 是否在 store 销毁后保持订阅 */
-    detached?: boolean;
-}
-/**
- * 发布订阅管理器接口
- */
-export interface PubSub<T = unknown> {
-    /**
-     * 订阅
-     * @param callback - 回调函数
-     * @param options - 订阅选项
-     * @returns 取消订阅函数
-     */
-    subscribe: (callback: Subscriber<T>, options?: SubscriptionOptions) => Unsubscribe;
-    /**
-     * 发布
-     * @param value - 新值
-     * @param oldValue - 旧值
-     */
-    publish: (value: T, oldValue?: T) => void;
-    /**
-     * 清空所有订阅
-     */
-    clear: () => void;
-    /**
-     * 获取订阅者数量
-     */
-    size: () => number;
-}
-/**
- * 事件类型
- */
-export type EventType = 'store:created' | 'store:disposed' | 'state:changed' | 'action:called' | 'action:completed' | 'action:error' | 'plugin:installed' | 'plugin:uninstalled';
-/**
- * 事件数据
- */
-export interface EventData {
-    /** 事件类型 */
-    type: EventType;
-    /** Store ID */
-    storeId?: StoreId;
-    /** 事件数据 */
-    payload?: unknown;
-    /** 时间戳 */
-    timestamp: number;
-}
-/**
- * 事件监听器类型
- */
-export type EventListener = (data: EventData) => void;
-/**
- * 事件总线接口
- */
-export interface EventBus {
-    /**
-     * 监听事件
-     * @param type - 事件类型
-     * @param listener - 监听器
-     * @returns 取消监听函数
-     */
-    on: (type: EventType | '*', listener: EventListener) => Unsubscribe;
-    /**
-     * 监听一次
-     * @param type - 事件类型
-     * @param listener - 监听器
-     * @returns 取消监听函数
-     */
-    once: (type: EventType, listener: EventListener) => Unsubscribe;
-    /**
-     * 取消监听
-     * @param type - 事件类型
-     * @param listener - 监听器
-     */
-    off: (type: EventType | '*', listener?: EventListener) => void;
-    /**
-     * 发送事件
-     * @param type - 事件类型
-     * @param payload - 事件数据
-     */
-    emit: (type: EventType, payload?: unknown) => void;
-    /**
-     * 清空所有监听器
-     */
-    clear: () => void;
-}
-/**
- * 选择器函数类型
- * @template S - 状态类型
- * @template R - 返回值类型
- */
-export type Selector<S extends StateTree, R> = (state: S) => R;
-/**
- * 选择器订阅选项
- */
-export interface SelectorOptions<R> {
-    /** 是否立即执行 */
-    immediate?: boolean;
-    /** 相等性比较函数 */
-    equalityFn?: (a: R, b: R) => boolean;
-}
-/**
- * 批量更新上下文
- */
-export interface BatchContext {
-    /** 是否正在批量更新 */
-    isBatching: boolean;
-    /** 待更新的 Store ID 列表 */
-    pendingStores: Set<StoreId>;
-}
-/**
- * 批量更新管理器接口
- */
-export interface BatchManager {
-    /**
-     * 开始批量更新
-     */
-    start: () => void;
-    /**
-     * 结束批量更新并通知所有订阅者
-     */
-    end: () => void;
-    /**
-     * 标记 Store 需要更新
-     * @param storeId - Store ID
-     */
-    markDirty: (storeId: StoreId) => void;
-    /**
-     * 在批量上下文中执行
-     * @param fn - 执行函数
-     */
-    batch: <T>(fn: () => T) => T;
-    /**
-     * 是否正在批量更新
-     */
-    isBatching: () => boolean;
-}
-//# sourceMappingURL=subscription.d.ts.map

package/esm/types/utility.d.ts

@@ -1,312 +0,0 @@
-/**
- * 工具类型定义
- *
- * 提供常用的类型工具，用于增强类型安全
- * @module types/utility
- */
-/**
- * 深度部分类型
- *
- * 将对象的所有属性（包括嵌套属性）设为可选
- *
- * @template T - 原始类型
- *
- * @example
- * ```typescript
- * interface User {
- *   name: string
- *   address: { city: string; zip: string }
- * }
- *
- * type PartialUser = DeepPartial<User>
- * // { name?: string; address?: { city?: string; zip?: string } }
- * ```
- */
-export type DeepPartial<T> = T extends object ? T extends Array<infer U> ? Array<DeepPartial<U>> : T extends Map<infer K, infer V> ? Map<DeepPartial<K>, DeepPartial<V>> : T extends Set<infer U> ? Set<DeepPartial<U>> : T extends Function ? T : {
-    [P in keyof T]?: DeepPartial<T[P]>;
-} : T;
-/**
- * 深度只读类型
- *
- * 将对象的所有属性（包括嵌套属性）设为只读
- *
- * @template T - 原始类型
- *
- * @example
- * ```typescript
- * interface Config {
- *   api: { url: string; timeout: number }
- * }
- *
- * type ReadonlyConfig = DeepReadonly<Config>
- * // { readonly api: { readonly url: string; readonly timeout: number } }
- * ```
- */
-export type DeepReadonly<T> = T extends object ? T extends Array<infer U> ? ReadonlyArray<DeepReadonly<U>> : T extends Map<infer K, infer V> ? ReadonlyMap<DeepReadonly<K>, DeepReadonly<V>> : T extends Set<infer U> ? ReadonlySet<DeepReadonly<U>> : T extends Function ? T : {
-    readonly [P in keyof T]: DeepReadonly<T[P]>;
-} : T;
-/**
- * 只读 Map 类型
- */
-type ReadonlyMap<K, V> = Omit<Map<K, V>, 'set' | 'delete' | 'clear'>;
-/**
- * 只读 Set 类型
- */
-type ReadonlySet<T> = Omit<Set<T>, 'add' | 'delete' | 'clear'>;
-/**
- * 获取对象的所有路径
- *
- * @template T - 对象类型
- *
- * @example
- * ```typescript
- * interface State {
- *   user: { name: string; age: number }
- *   settings: { theme: string }
- * }
- *
- * type Paths = PathsOf<State>
- * // 'user' | 'user.name' | 'user.age' | 'settings' | 'settings.theme'
- * ```
- */
-export type PathsOf<T, Prefix extends string = ''> = T extends object ? T extends Array<unknown> ? Prefix : {
-    [K in keyof T & string]: K extends string ? Prefix extends '' ? K | PathsOf<T[K], K> : `${Prefix}.${K}` | PathsOf<T[K], `${Prefix}.${K}`> : never;
-}[keyof T & string] : Prefix;
-/**
- * 根据路径获取类型
- *
- * @template T - 对象类型
- * @template P - 路径字符串
- *
- * @example
- * ```typescript
- * interface State {
- *   user: { name: string; age: number }
- * }
- *
- * type UserName = PathValue<State, 'user.name'> // string
- * type User = PathValue<State, 'user'> // { name: string; age: number }
- * ```
- */
-export type PathValue<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? PathValue<T[K], Rest> : never : P extends keyof T ? T[P] : never;
-/**
- * 提取函数的参数类型
- *
- * @template T - 函数类型
- */
-export type ArgumentsOf<T extends (...args: unknown[]) => unknown> = T extends (...args: infer P) => unknown ? P : never;
-/**
- * 提取函数的返回类型（异步函数自动解包 Promise）
- *
- * @template T - 函数类型
- */
-export type AsyncReturnType<T extends (...args: unknown[]) => unknown> = T extends (...args: unknown[]) => Promise<infer R> ? R : T extends (...args: unknown[]) => infer R ? R : never;
-/**
- * 非空类型
- *
- * 从类型中排除 null 和 undefined
- *
- * @template T - 原始类型
- */
-export type NonNullable<T> = T extends null | undefined ? never : T;
-/**
- * 可为 null 的类型
- *
- * @template T - 原始类型
- */
-export type Nullable<T> = T | null;
-/**
- * 可选的类型
- *
- * @template T - 原始类型
- */
-export type Optional<T> = T | undefined;
-/**
- * 品牌类型
- *
- * 用于创建名义类型系统
- *
- * @template T - 基础类型
- * @template Brand - 品牌标识
- *
- * @example
- * ```typescript
- * type UserId = Brand<string, 'UserId'>
- * type PostId = Brand<string, 'PostId'>
- *
- * // UserId 和 PostId 不能互相赋值，即使底层都是 string
- * ```
- */
-export type Brand<T, Brand extends string> = T & {
-    __brand: Brand;
-};
-/**
- * 严格对象类型
- *
- * 确保对象不包含多余的属性
- *
- * @template T - 期望类型
- * @template Actual - 实际类型
- */
-export type Exact<T, Actual extends T> = T & {
-    [K in keyof Actual]: K extends keyof T ? T[K] : never;
-};
-/**
- * 获取对象的必需键
- *
- * @template T - 对象类型
- */
-export type RequiredKeys<T> = {
-    [K in keyof T]-?: undefined extends T[K] ? never : K;
-}[keyof T];
-/**
- * 获取对象的可选键
- *
- * @template T - 对象类型
- */
-export type OptionalKeys<T> = {
-    [K in keyof T]-?: undefined extends T[K] ? K : never;
-}[keyof T];
-/**
- * 选择对象的部分属性设为必需
- *
- * @template T - 对象类型
- * @template K - 需要设为必需的键
- */
-export type RequireKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
-/**
- * 选择对象的部分属性设为可选
- *
- * @template T - 对象类型
- * @template K - 需要设为可选的键
- */
-export type PartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-/**
- * 合并两个类型
- *
- * 第二个类型的属性会覆盖第一个类型
- *
- * @template T - 第一个类型
- * @template U - 第二个类型
- */
-export type Merge<T, U> = Omit<T, keyof U> & U;
-/**
- * 获取两个类型的公共键
- *
- * @template T - 第一个类型
- * @template U - 第二个类型
- */
-export type CommonKeys<T, U> = keyof T & keyof U;
-/**
- * 函数类型
- */
-export type AnyFunction = (...args: unknown[]) => unknown;
-/**
- * 异步函数类型
- */
-export type AsyncFunction = (...args: unknown[]) => Promise<unknown>;
-/**
- * 类类型
- *
- * @template T - 实例类型
- */
-export type Constructor<T = unknown> = new (...args: unknown[]) => T;
-/**
- * 抽象类类型
- *
- * @template T - 实例类型
- */
-export type AbstractConstructor<T = unknown> = abstract new (...args: unknown[]) => T;
-/**
- * 确保类型不为 never
- *
- * @template T - 待检查类型
- */
-export type IsNever<T> = [T] extends [never] ? true : false;
-/**
- * 确保类型是数组
- *
- * @template T - 待检查类型
- */
-export type IsArray<T> = T extends unknown[] ? true : false;
-/**
- * 确保类型是对象（非数组、非函数）
- *
- * @template T - 待检查类型
- */
-export type IsPlainObject<T> = T extends object ? T extends Function ? false : T extends unknown[] ? false : true : false;
-/**
- * 值类型为指定类型的键
- *
- * @template T - 对象类型
- * @template V - 值类型
- *
- * @example
- * ```typescript
- * interface User {
- *   id: number
- *   name: string
- *   age: number
- * }
- *
- * type NumberKeys = KeysOfType<User, number> // 'id' | 'age'
- * ```
- */
-export type KeysOfType<T, V> = {
-    [K in keyof T]: T[K] extends V ? K : never;
-}[keyof T];
-/**
- * 排除值类型为指定类型的键
- *
- * @template T - 对象类型
- * @template V - 要排除的值类型
- */
-export type KeysExcludeType<T, V> = {
-    [K in keyof T]: T[K] extends V ? never : K;
-}[keyof T];
-/**
- * 仅保留值类型为指定类型的属性
- *
- * @template T - 对象类型
- * @template V - 值类型
- */
-export type PickByType<T, V> = Pick<T, KeysOfType<T, V>>;
-/**
- * 排除值类型为指定类型的属性
- *
- * @template T - 对象类型
- * @template V - 要排除的值类型
- */
-export type OmitByType<T, V> = Pick<T, KeysExcludeType<T, V>>;
-/**
- * 提取 Promise 的值类型
- *
- * @template T - Promise 类型
- */
-export type Awaited<T> = T extends Promise<infer U> ? Awaited<U> : T;
-/**
- * 联合类型转交叉类型
- *
- * @template U - 联合类型
- */
-export type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-/**
- * 元组类型转联合类型
- *
- * @template T - 元组类型
- */
-export type TupleToUnion<T extends unknown[]> = T[number];
-/**
- * 字符串字面量首字母大写
- *
- * @template S - 字符串类型
- */
-export type Capitalize<S extends string> = S extends `${infer F}${infer R}` ? `${Uppercase<F>}${R}` : S;
-/**
- * 字符串字面量首字母小写
- *
- * @template S - 字符串类型
- */
-export type Uncapitalize<S extends string> = S extends `${infer F}${infer R}` ? `${Lowercase<F>}${R}` : S;
-export {};
-//# sourceMappingURL=utility.d.ts.map