@signaltree/core 3.0.2 → 4.0.1

package/index.d.ts

@@ -1,216 +0,0 @@
-import { WritableSignal, Signal } from '@angular/core';
-
-type NotFn<T> = T extends (...args: unknown[]) => unknown ? never : T;
-declare module '@angular/core' {
-    interface WritableSignal<T> {
-        (value: NotFn<T>): void;
-        (updater: (current: T) => T): void;
-    }
-}
-type Primitive = string | number | boolean | null | undefined | bigint | symbol;
-type BuiltInObject = Date | RegExp | ((...args: unknown[]) => unknown) | Map<unknown, unknown> | Set<unknown> | WeakMap<object, unknown> | WeakSet<object> | ArrayBuffer | DataView | Error | Promise<unknown> | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array | URL | URLSearchParams | FormData | Blob | File | Headers | Request | Response | AbortController | AbortSignal;
-interface NodeAccessor<T> {
-    (): T;
-    (value: T): void;
-    (updater: (current: T) => T): void;
-}
-type AccessibleNode<T> = NodeAccessor<T> & TreeNode<T>;
-type CallableWritableSignal<T> = WritableSignal<T> & {
-    (value: NotFn<T>): void;
-    (updater: (current: T) => T): void;
-};
-type TreeNode<T> = {
-    [K in keyof T]: T[K] extends readonly unknown[] ? CallableWritableSignal<T[K]> : T[K] extends object ? T[K] extends Signal<unknown> ? T[K] : T[K] extends BuiltInObject ? CallableWritableSignal<T[K]> : T[K] extends (...args: unknown[]) => unknown ? CallableWritableSignal<T[K]> : AccessibleNode<T[K]> : CallableWritableSignal<T[K]>;
-};
-type RemoveSignalMethods<T> = T extends infer U ? U : never;
-interface EnhancerMeta {
-    name?: string;
-    requires?: string[];
-    provides?: string[];
-}
-type Enhancer<Input = unknown, Output = unknown> = (input: Input) => Output;
-type EnhancerWithMeta<Input = unknown, Output = unknown> = Enhancer<Input, Output> & {
-    metadata?: EnhancerMeta;
-};
-declare const ENHANCER_META: unique symbol;
-type ChainResult<Start, E extends Array<EnhancerWithMeta<unknown, unknown>>> = E extends [infer H, ...infer R] ? H extends EnhancerWithMeta<SignalTree<any>, infer O> ? R extends Array<EnhancerWithMeta<unknown, unknown>> ? ChainResult<O, R> : O : H extends EnhancerWithMeta<infer I, infer O> ? Start extends I ? R extends Array<EnhancerWithMeta<unknown, unknown>> ? ChainResult<O, R> : O : any : unknown : Start;
-interface WithMethod<T> {
-    (): SignalTree<T>;
-    <O1>(e1: (input: SignalTree<T>) => O1): O1;
-    <O1, O2>(e1: (input: SignalTree<T>) => O1, e2: (input: O1) => O2): O2;
-    <O1, O2, O3>(e1: (input: SignalTree<T>) => O1, e2: (input: O1) => O2, e3: (input: O2) => O3): O3;
-    <O1, O2, O3, O4>(e1: (input: SignalTree<T>) => O1, e2: (input: O1) => O2, e3: (input: O2) => O3, e4: (input: O3) => O4): O4;
-    <O1>(e1: EnhancerWithMeta<SignalTree<T>, O1>): O1;
-    <O1>(e1: EnhancerWithMeta<SignalTree<any>, O1>): O1;
-    <O1>(e1: EnhancerWithMeta<SignalTree<T>, O1>): O1;
-    <O1>(e1: EnhancerWithMeta<SignalTree<any>, O1>, e2: EnhancerWithMeta<O1, unknown>): unknown;
-    <O1, O2>(e1: EnhancerWithMeta<SignalTree<T>, O1>, e2: EnhancerWithMeta<O1, O2>): O2;
-    <O1, O2>(e1: EnhancerWithMeta<SignalTree<any>, O1>, e2: EnhancerWithMeta<O1, O2>): O2;
-    <O1, O2, O3>(e1: EnhancerWithMeta<SignalTree<T>, O1>, e2: EnhancerWithMeta<O1, O2>, e3: EnhancerWithMeta<O2, O3>): O3;
-    <O1, O2, O3>(e1: EnhancerWithMeta<SignalTree<any>, O1>, e2: EnhancerWithMeta<O1, O2>, e3: EnhancerWithMeta<O2, O3>): O3;
-    <O1, O2, O3, O4>(e1: EnhancerWithMeta<SignalTree<T>, O1>, e2: EnhancerWithMeta<O1, O2>, e3: EnhancerWithMeta<O2, O3>, e4: EnhancerWithMeta<O3, O4>): O4;
-    <O1, O2, O3, O4>(e1: EnhancerWithMeta<SignalTree<any>, O1>, e2: EnhancerWithMeta<O1, O2>, e3: EnhancerWithMeta<O2, O3>, e4: EnhancerWithMeta<O3, O4>): O4;
-    <O1, O2>(e1: EnhancerWithMeta<SignalTree<T>, O1>, e2: EnhancerWithMeta<O1, O2>): O2;
-    <O1, O2, O3>(e1: EnhancerWithMeta<SignalTree<T>, O1>, e2: EnhancerWithMeta<O1, O2>, e3: EnhancerWithMeta<O2, O3>): O3;
-    <O1, O2, O3, O4>(e1: EnhancerWithMeta<SignalTree<T>, O1>, e2: EnhancerWithMeta<O1, O2>, e3: EnhancerWithMeta<O2, O3>, e4: EnhancerWithMeta<O3, O4>): O4;
-}
-type SignalTree<T> = NodeAccessor<T> & {
-    state: TreeNode<T>;
-    $: TreeNode<T>;
-    with: WithMethod<T>;
-    destroy(): void;
-    effect(fn: (tree: T) => void): void;
-    subscribe(fn: (tree: T) => void): () => void;
-    batch(updater: (tree: T) => void): void;
-    batchUpdate(updater: (current: T) => Partial<T>): void;
-    memoize<R>(fn: (tree: T) => R, cacheKey?: string): Signal<R>;
-    memoizedUpdate(updater: (current: T) => Partial<T>, cacheKey?: string): void;
-    clearMemoCache(key?: string): void;
-    getCacheStats(): {
-        size: number;
-        hitRate: number;
-        totalHits: number;
-        totalMisses: number;
-        keys: string[];
-    };
-    optimize(): void;
-    clearCache(): void;
-    invalidatePattern(pattern: string): number;
-    getMetrics(): PerformanceMetrics;
-    addTap(middleware: Middleware<T>): void;
-    removeTap(id: string): void;
-    entities<E extends {
-        id: string | number;
-    }>(entityKey?: keyof T): EntityHelpers<E>;
-    asyncAction<TInput, TResult>(operation: (input: TInput) => Promise<TResult>, config?: AsyncActionConfig<T, TResult>): AsyncAction<TInput, TResult>;
-    undo(): void;
-    redo(): void;
-    getHistory(): TimeTravelEntry<T>[];
-    resetHistory(): void;
-    jumpTo?: (index: number) => void;
-    canUndo?: () => boolean;
-    canRedo?: () => boolean;
-    getCurrentIndex?: () => number;
-    [key: string]: unknown;
-};
-type TreePreset = 'basic' | 'performance' | 'development' | 'production';
-interface TreeConfig {
-    batchUpdates?: boolean;
-    useMemoization?: boolean;
-    enableTimeTravel?: boolean;
-    useLazySignals?: boolean;
-    useShallowComparison?: boolean;
-    maxCacheSize?: number;
-    trackPerformance?: boolean;
-    treeName?: string;
-    enableDevTools?: boolean;
-    debugMode?: boolean;
-    useStructuralSharing?: boolean;
-}
-interface Middleware<T> {
-    id: string;
-    before?: (action: string, payload: unknown, state: T) => boolean;
-    after?: (action: string, payload: unknown, state: T, newState: T) => void;
-}
-interface PerformanceMetrics {
-    updates: number;
-    computations: number;
-    cacheHits: number;
-    cacheMisses: number;
-    averageUpdateTime: number;
-}
-interface EntityHelpers<E extends {
-    id: string | number;
-}> {
-    add(entity: E): void;
-    update(id: E['id'], updates: Partial<E>): void;
-    remove(id: E['id']): void;
-    upsert(entity: E): void;
-    selectById(id: E['id']): Signal<E | undefined>;
-    selectBy(predicate: (entity: E) => boolean): Signal<E[]>;
-    selectIds(): Signal<Array<string | number>>;
-    selectAll(): Signal<E[]>;
-    selectTotal(): Signal<number>;
-    clear(): void;
-}
-interface AsyncActionConfig<T, TResult> {
-    onStart?: (state: T) => Partial<T>;
-    onSuccess?: (result: TResult, state: T) => Partial<T>;
-    onError?: (error: Error, state: T) => Partial<T>;
-    onComplete?: (state: T) => Partial<T>;
-}
-interface AsyncAction<TInput, TResult> {
-    execute(input: TInput): Promise<TResult>;
-    pending: Signal<boolean>;
-    error: Signal<Error | null>;
-    result: Signal<TResult | null>;
-}
-interface TimeTravelEntry<T> {
-    action: string;
-    timestamp: number;
-    state: T;
-    payload?: unknown;
-}
-
-declare function signalTree<T>(obj: T): SignalTree<T>;
-declare function signalTree<T>(obj: T, preset: TreePreset): SignalTree<T>;
-declare function signalTree<T>(obj: T, config: TreeConfig): SignalTree<T>;
-declare function signalTree<T extends Record<string, unknown>>(obj: Required<T>, configOrPreset?: TreeConfig | TreePreset): SignalTree<Required<T>>;
-declare function signalTree<T>(obj: T, configOrPreset?: TreeConfig | TreePreset): SignalTree<T>;
-
-declare function equal<T>(a: T, b: T): boolean;
-declare const deepEqual: typeof equal;
-declare function isBuiltInObject(v: unknown): boolean;
-declare function isNodeAccessor(value: unknown): value is NodeAccessor<unknown>;
-declare function isAnySignal(value: unknown): boolean;
-declare function parsePath(path: string): string[];
-declare function composeEnhancers<T>(...enhancers: Array<(tree: T) => T>): (tree: T) => T;
-declare function createLazySignalTree<T extends object>(obj: T, equalityFn: (a: unknown, b: unknown) => boolean, basePath?: string): TreeNode<T>;
-
-declare function createEnhancer<I = unknown, O = unknown>(meta: EnhancerMeta, enhancerFn: (input: I) => O): EnhancerWithMeta<I, O>;
-declare function resolveEnhancerOrder(enhancers: EnhancerWithMeta<unknown, unknown>[], availableCapabilities?: Set<string>, debugMode?: boolean): EnhancerWithMeta<unknown, unknown>[];
-
-declare const SIGNAL_TREE_CONSTANTS: {
-    readonly MAX_PATH_CACHE_SIZE: 1000;
-    readonly LAZY_THRESHOLD: 50;
-    readonly ESTIMATE_MAX_DEPTH: 3;
-    readonly ESTIMATE_SAMPLE_SIZE_ARRAY: 3;
-    readonly ESTIMATE_SAMPLE_SIZE_OBJECT: 5;
-    readonly DEFAULT_CACHE_SIZE: 100;
-    readonly DEFAULT_BATCH_SIZE: 10;
-};
-declare const SIGNAL_TREE_MESSAGES: Readonly<{
-    readonly NULL_OR_UNDEFINED: "null/undefined";
-    readonly CIRCULAR_REF: "circular ref";
-    readonly UPDATER_INVALID: "updater invalid";
-    readonly LAZY_FALLBACK: "lazy fallback";
-    readonly SIGNAL_CREATION_FAILED: "signal creation failed";
-    readonly UPDATE_PATH_NOT_FOUND: "update path not found";
-    readonly UPDATE_FAILED: "update failed";
-    readonly ROLLBACK_FAILED: "rollback failed";
-    readonly CLEANUP_ERROR: "cleanup error";
-    readonly PRESET_UNKNOWN: "unknown preset";
-    readonly STRATEGY_SELECTION: "strategy select";
-    readonly TREE_DESTROYED: "destroyed";
-    readonly UPDATE_TRANSACTION: "update tx";
-    readonly BATCH_NOT_ENABLED: "batching disabled";
-    readonly MEMOIZE_NOT_ENABLED: "memoize disabled";
-    readonly MIDDLEWARE_NOT_AVAILABLE: "middleware missing";
-    readonly ENTITY_HELPERS_NOT_AVAILABLE: "entity helpers missing";
-    readonly ASYNC_ACTIONS_NOT_AVAILABLE: "async actions missing";
-    readonly TIME_TRAVEL_NOT_AVAILABLE: "time travel missing";
-    readonly OPTIMIZE_NOT_AVAILABLE: "optimize missing";
-    readonly CACHE_NOT_AVAILABLE: "cache missing";
-    readonly PERFORMANCE_NOT_ENABLED: "performance disabled";
-    readonly ENHANCER_ORDER_FAILED: "enhancer order failed";
-    readonly ENHANCER_CYCLE_DETECTED: "enhancer cycle";
-    readonly ENHANCER_REQUIREMENT_MISSING: "enhancer req missing";
-    readonly ENHANCER_PROVIDES_MISSING: "enhancer provides missing";
-    readonly ENHANCER_FAILED: "enhancer failed";
-    readonly ENHANCER_NOT_FUNCTION: "enhancer not function";
-    readonly EFFECT_NO_CONTEXT: "no angular context";
-    readonly SUBSCRIBE_NO_CONTEXT: "no angular context";
-}>;
-
-export { ENHANCER_META, SIGNAL_TREE_CONSTANTS, SIGNAL_TREE_MESSAGES, composeEnhancers, createEnhancer, createLazySignalTree, deepEqual, equal, isAnySignal, isBuiltInObject, isNodeAccessor, parsePath, resolveEnhancerOrder, signalTree };
-export type { AsyncAction, AsyncActionConfig, BuiltInObject, ChainResult, Enhancer, EnhancerMeta, EnhancerWithMeta, EntityHelpers, Middleware, NotFn, PerformanceMetrics, Primitive, RemoveSignalMethods, SignalTree, TimeTravelEntry, TreeConfig, TreeNode, TreePreset, WithMethod };