@signaltree/core 5.1.6 → 6.0.1

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 (84) hide show
  1. package/README.md +76 -76
  2. package/dist/enhancers/batching/{lib/batching.js → batching.js} +45 -17
  3. package/dist/enhancers/devtools/{lib/devtools.js → devtools.js} +83 -98
  4. package/dist/enhancers/effects/effects.js +66 -0
  5. package/dist/enhancers/entities/entities.js +51 -0
  6. package/dist/enhancers/memoization/{lib/memoization.js → memoization.js} +33 -23
  7. package/dist/enhancers/presets/lib/presets.js +5 -65
  8. package/dist/enhancers/serialization/{lib/serialization.js → serialization.js} +12 -18
  9. package/dist/enhancers/time-travel/{lib/time-travel.js → time-travel.js} +62 -24
  10. package/dist/enhancers/time-travel/utils.js +11 -0
  11. package/dist/index.js +8 -8
  12. package/dist/lib/async-helpers.js +6 -6
  13. package/dist/lib/presets.js +21 -0
  14. package/dist/lib/signal-tree.js +156 -496
  15. package/dist/lib/types.js +1 -1
  16. package/dist/lib/utils.js +40 -2
  17. package/package.json +1 -6
  18. package/src/enhancers/batching/batching.d.ts +11 -0
  19. package/src/enhancers/batching/index.d.ts +1 -1
  20. package/src/enhancers/devtools/{lib/devtools.d.ts → devtools.d.ts} +10 -19
  21. package/src/enhancers/devtools/devtools.types.d.ts +1 -0
  22. package/src/enhancers/devtools/index.d.ts +1 -1
  23. package/src/enhancers/effects/effects.d.ts +9 -0
  24. package/src/enhancers/effects/effects.types.d.ts +1 -0
  25. package/src/enhancers/effects/index.d.ts +1 -0
  26. package/src/enhancers/entities/entities.d.ts +11 -0
  27. package/src/enhancers/entities/entities.types.d.ts +1 -0
  28. package/src/enhancers/entities/index.d.ts +1 -1
  29. package/src/enhancers/index.d.ts +3 -3
  30. package/src/enhancers/memoization/index.d.ts +1 -1
  31. package/src/enhancers/memoization/memoization.d.ts +54 -0
  32. package/src/enhancers/memoization/memoization.types.d.ts +1 -0
  33. package/src/enhancers/presets/lib/presets.d.ts +3 -6
  34. package/src/enhancers/serialization/index.d.ts +1 -1
  35. package/src/{serialization.d.ts → enhancers/serialization/serialization.d.ts} +17 -8
  36. package/src/enhancers/test-helpers/types-equals.d.ts +2 -0
  37. package/src/enhancers/time-travel/index.d.ts +1 -1
  38. package/src/enhancers/time-travel/time-travel.d.ts +10 -0
  39. package/src/enhancers/time-travel/time-travel.types.d.ts +1 -0
  40. package/src/enhancers/time-travel/utils.d.ts +2 -0
  41. package/src/enhancers/types.d.ts +1 -74
  42. package/src/enhancers/typing/helpers-types.d.ts +2 -0
  43. package/src/index.d.ts +7 -8
  44. package/src/lib/async-helpers.d.ts +2 -2
  45. package/src/lib/dev-proxy.d.ts +3 -0
  46. package/src/lib/presets.d.ts +34 -0
  47. package/src/lib/signal-tree.d.ts +2 -7
  48. package/src/lib/types.d.ts +121 -90
  49. package/src/lib/utils.d.ts +4 -0
  50. package/dist/deep-clone.js +0 -80
  51. package/dist/enhancers/computed/lib/computed.js +0 -21
  52. package/dist/enhancers/entities/lib/entities.js +0 -66
  53. package/dist/lib/performance/diff-engine.js +0 -156
  54. package/dist/lib/performance/path-index.js +0 -156
  55. package/dist/lib/performance/update-engine.js +0 -188
  56. package/src/async-helpers.d.ts +0 -8
  57. package/src/batching.d.ts +0 -16
  58. package/src/computed.d.ts +0 -12
  59. package/src/constants.d.ts +0 -14
  60. package/src/devtools.d.ts +0 -77
  61. package/src/diff-engine.d.ts +0 -33
  62. package/src/enhancers/batching/lib/batching.d.ts +0 -16
  63. package/src/enhancers/computed/index.d.ts +0 -1
  64. package/src/enhancers/computed/lib/computed.d.ts +0 -12
  65. package/src/enhancers/entities/lib/entities.d.ts +0 -17
  66. package/src/enhancers/memoization/lib/memoization.d.ts +0 -65
  67. package/src/enhancers/presets/test-setup.d.ts +0 -3
  68. package/src/enhancers/serialization/lib/serialization.d.ts +0 -59
  69. package/src/enhancers/time-travel/lib/time-travel.d.ts +0 -36
  70. package/src/enhancers/time-travel/lib/utils.d.ts +0 -1
  71. package/src/entities.d.ts +0 -28
  72. package/src/memoization.d.ts +0 -65
  73. package/src/memory-manager.d.ts +0 -30
  74. package/src/path-index.d.ts +0 -25
  75. package/src/path-notifier.d.ts +0 -12
  76. package/src/presets.d.ts +0 -11
  77. package/src/security-validator.d.ts +0 -33
  78. package/src/signal-tree.d.ts +0 -8
  79. package/src/test-setup.d.ts +0 -3
  80. package/src/time-travel.d.ts +0 -36
  81. package/src/types.d.ts +0 -436
  82. package/src/update-engine.d.ts +0 -32
  83. package/src/utils.d.ts +0 -1
  84. /package/src/{entity-signal.d.ts → enhancers/batching/batching.types.d.ts} +0 -0
@@ -1,59 +0,0 @@
1
- import type { SignalTree } from '../../../lib/types';
2
- import type { EnhancerWithMeta } from '../../../lib/types';
3
- export interface SerializationConfig {
4
- includeMetadata?: boolean;
5
- replacer?: (key: string, value: unknown) => unknown;
6
- reviver?: (key: string, value: unknown) => unknown;
7
- preserveTypes?: boolean;
8
- maxDepth?: number;
9
- handleCircular?: boolean;
10
- }
11
- export interface SerializedState<T = unknown> {
12
- data: T;
13
- metadata?: {
14
- timestamp: number;
15
- version: string;
16
- appVersion?: string;
17
- types?: Record<string, string>;
18
- circularRefs?: Array<{
19
- path: string;
20
- targetPath: string;
21
- }>;
22
- nodeMap?: Record<string, 'b' | 'r'>;
23
- };
24
- }
25
- export interface SerializableSignalTree<T> extends SignalTree<T> {
26
- $: any;
27
- serialize(config?: SerializationConfig): string;
28
- deserialize(json: string, config?: SerializationConfig): void;
29
- toJSON(): T;
30
- fromJSON(data: T, metadata?: SerializedState<T>['metadata']): void;
31
- snapshot(): SerializedState<T>;
32
- restore(snapshot: SerializedState<T>): void;
33
- }
34
- export interface PersistenceMethods {
35
- save(): Promise<void>;
36
- load(): Promise<void>;
37
- clear(): Promise<void>;
38
- __flushAutoSave?: () => Promise<void>;
39
- }
40
- export declare function withSerialization<T extends Record<string, unknown> = Record<string, unknown>>(defaultConfig?: SerializationConfig): EnhancerWithMeta<SignalTree<T>, SerializableSignalTree<T>>;
41
- export declare function enableSerialization<T extends Record<string, unknown> = Record<string, unknown>>(): EnhancerWithMeta<SignalTree<T>, SerializableSignalTree<T>>;
42
- export interface StorageAdapter {
43
- getItem(key: string): string | null | Promise<string | null>;
44
- setItem(key: string, value: string): void | Promise<void>;
45
- removeItem(key: string): void | Promise<void>;
46
- }
47
- export interface PersistenceConfig extends SerializationConfig {
48
- key: string;
49
- storage?: StorageAdapter;
50
- autoSave?: boolean;
51
- debounceMs?: number;
52
- autoLoad?: boolean;
53
- skipCache?: boolean;
54
- }
55
- export declare function withPersistence<T extends Record<string, unknown> = Record<string, unknown>>(config: PersistenceConfig): EnhancerWithMeta<SignalTree<T>, SerializableSignalTree<T> & PersistenceMethods>;
56
- export declare function createStorageAdapter(getItem: (key: string) => string | null | Promise<string | null>, setItem: (key: string, value: string) => void | Promise<void>, removeItem: (key: string) => void | Promise<void>): StorageAdapter;
57
- export declare function createIndexedDBAdapter(dbName?: string, storeName?: string): StorageAdapter;
58
- export declare function applySerialization<T extends Record<string, unknown>>(tree: SignalTree<T>): SerializableSignalTree<T>;
59
- export declare function applyPersistence<T extends Record<string, unknown>>(tree: SignalTree<T>, cfg: PersistenceConfig): SerializableSignalTree<T> & PersistenceMethods;
@@ -1,36 +0,0 @@
1
- import type { SignalTree } from '../../../lib/types';
2
- export interface TimeTravelEntry<T> {
3
- state: T;
4
- timestamp: number;
5
- action: string;
6
- payload?: unknown;
7
- }
8
- export interface TimeTravelInterface<T> {
9
- undo(): boolean;
10
- redo(): boolean;
11
- getHistory(): TimeTravelEntry<T>[];
12
- resetHistory(): void;
13
- jumpTo(index: number): boolean;
14
- getCurrentIndex(): number;
15
- canUndo(): boolean;
16
- canRedo(): boolean;
17
- }
18
- export interface TimeTravelConfig {
19
- maxHistorySize?: number;
20
- includePayload?: boolean;
21
- actionNames?: {
22
- update?: string;
23
- set?: string;
24
- batch?: string;
25
- [key: string]: string | undefined;
26
- };
27
- }
28
- export declare function withTimeTravel<T>(config?: TimeTravelConfig): (tree: SignalTree<T>) => SignalTree<T> & {
29
- __timeTravel: TimeTravelInterface<T>;
30
- };
31
- export declare function enableTimeTravel<T>(maxHistorySize?: number): (tree: SignalTree<T>) => SignalTree<T> & {
32
- __timeTravel: TimeTravelInterface<T>;
33
- };
34
- export declare function getTimeTravel<T>(tree: SignalTree<T> & {
35
- __timeTravel?: TimeTravelInterface<T>;
36
- }): TimeTravelInterface<T> | undefined;
@@ -1 +0,0 @@
1
- export { deepClone, deepEqual } from '@signaltree/shared';
package/src/entities.d.ts DELETED
@@ -1,28 +0,0 @@
1
- import type {
2
- EntitySignal,
3
- SignalTree,
4
- EntityAwareTreeNode,
5
- } from '../../../lib/types';
6
- interface EntitiesEnhancerConfig {
7
- enabled?: boolean;
8
- }
9
- export declare function withEntities(config?: EntitiesEnhancerConfig): <T>(
10
- tree: SignalTree<T>
11
- ) => Omit<SignalTree<T>, 'state' | '$'> & {
12
- state: EntityAwareTreeNode<T>;
13
- $: EntityAwareTreeNode<T>;
14
- };
15
- export declare function enableEntities(): <T>(tree: SignalTree<T>) => Omit<
16
- SignalTree<T>,
17
- 'state' | '$'
18
- > & {
19
- state: EntityAwareTreeNode<T>;
20
- $: EntityAwareTreeNode<T>;
21
- };
22
- export declare function withHighPerformanceEntities(): <T>(
23
- tree: SignalTree<T>
24
- ) => Omit<SignalTree<T>, 'state' | '$'> & {
25
- state: EntityAwareTreeNode<T>;
26
- $: EntityAwareTreeNode<T>;
27
- };
28
- export {};
@@ -1,65 +0,0 @@
1
- import type { SignalTree } from '../../../lib/types';
2
- export interface MemoizedSignalTree<T> extends SignalTree<T> {
3
- memoizedUpdate: (updater: (current: T) => Partial<T>, cacheKey?: string) => void;
4
- clearMemoCache: (key?: string) => void;
5
- getCacheStats: () => {
6
- size: number;
7
- hitRate: number;
8
- totalHits: number;
9
- totalMisses: number;
10
- keys: string[];
11
- };
12
- }
13
- export declare function cleanupMemoizationCache(): void;
14
- export interface MemoizationConfig {
15
- enabled?: boolean;
16
- maxCacheSize?: number;
17
- ttl?: number;
18
- equality?: 'deep' | 'shallow' | 'reference';
19
- enableLRU?: boolean;
20
- }
21
- export declare function memoize<TArgs extends unknown[], TReturn>(fn: (...args: TArgs) => TReturn, keyFn?: (...args: TArgs) => string, config?: MemoizationConfig): (...args: TArgs) => TReturn;
22
- export declare function memoizeShallow<TArgs extends unknown[], TReturn>(fn: (...args: TArgs) => TReturn, keyFn?: (...args: TArgs) => string): (...args: TArgs) => TReturn;
23
- export declare function memoizeReference<TArgs extends unknown[], TReturn>(fn: (...args: TArgs) => TReturn, keyFn?: (...args: TArgs) => string): (...args: TArgs) => TReturn;
24
- export declare const MEMOIZATION_PRESETS: {
25
- readonly selector: {
26
- readonly equality: "reference";
27
- readonly maxCacheSize: 10;
28
- readonly enableLRU: false;
29
- readonly ttl: undefined;
30
- };
31
- readonly computed: {
32
- readonly equality: "shallow";
33
- readonly maxCacheSize: 100;
34
- readonly enableLRU: false;
35
- readonly ttl: undefined;
36
- };
37
- readonly deepState: {
38
- readonly equality: "deep";
39
- readonly maxCacheSize: 1000;
40
- readonly enableLRU: true;
41
- readonly ttl: number;
42
- };
43
- readonly highFrequency: {
44
- readonly equality: "reference";
45
- readonly maxCacheSize: 5;
46
- readonly enableLRU: false;
47
- readonly ttl: undefined;
48
- };
49
- };
50
- export declare function withSelectorMemoization<T>(): (tree: SignalTree<T>) => MemoizedSignalTree<T>;
51
- export declare function withComputedMemoization<T>(): (tree: SignalTree<T>) => MemoizedSignalTree<T>;
52
- export declare function withDeepStateMemoization<T>(): (tree: SignalTree<T>) => MemoizedSignalTree<T>;
53
- export declare function withHighFrequencyMemoization<T>(): (tree: SignalTree<T>) => MemoizedSignalTree<T>;
54
- export declare function withMemoization<T>(config?: MemoizationConfig): (tree: SignalTree<T>) => MemoizedSignalTree<T>;
55
- export declare function enableMemoization<T>(): (tree: SignalTree<T>) => MemoizedSignalTree<T>;
56
- export declare function withHighPerformanceMemoization<T>(): (tree: SignalTree<T>) => MemoizedSignalTree<T>;
57
- export declare function withLightweightMemoization<T>(): (tree: SignalTree<T>) => MemoizedSignalTree<T>;
58
- export declare function withShallowMemoization<T>(): (tree: SignalTree<T>) => MemoizedSignalTree<T>;
59
- export declare function clearAllCaches(): void;
60
- export declare function getGlobalCacheStats(): {
61
- treeCount: number;
62
- totalSize: number;
63
- totalHits: number;
64
- averageCacheSize: number;
65
- };
@@ -1,30 +0,0 @@
1
- import type { WritableSignal } from '@angular/core';
2
- export interface MemoryStats {
3
- cachedSignals: number;
4
- cleanedUpSignals: number;
5
- peakCachedSignals: number;
6
- manualDisposes: number;
7
- estimatedMemoryBytes: number;
8
- }
9
- export interface MemoryManagerConfig {
10
- enableAutoCleanup?: boolean;
11
- debugMode?: boolean;
12
- onCleanup?: (path: string, stats: MemoryStats) => void;
13
- }
14
- export declare class SignalMemoryManager {
15
- private cache;
16
- private registry;
17
- private config;
18
- private stats;
19
- constructor(config?: MemoryManagerConfig);
20
- cacheSignal<T>(path: string, signal: WritableSignal<T>): void;
21
- getSignal(path: string): WritableSignal<unknown> | undefined;
22
- hasSignal(path: string): boolean;
23
- removeSignal(path: string): boolean;
24
- private handleCleanup;
25
- getStats(): MemoryStats;
26
- dispose(): void;
27
- getCachedPaths(): string[];
28
- clearStale(): number;
29
- resetStats(): void;
30
- }
@@ -1,25 +0,0 @@
1
- import type { WritableSignal } from '@angular/core';
2
- export type PathSegment = string | number;
3
- export type Path = PathSegment[];
4
- export declare class PathIndex<T extends object = WritableSignal<any>> {
5
- private root;
6
- private pathCache;
7
- private stats;
8
- set(path: Path, signal: T): void;
9
- get(path: Path): T | null;
10
- has(path: Path): boolean;
11
- getByPrefix(prefix: Path): Map<string, T>;
12
- delete(path: Path): boolean;
13
- clear(): void;
14
- getStats(): {
15
- hits: number;
16
- misses: number;
17
- sets: number;
18
- cleanups: number;
19
- hitRate: number;
20
- cacheSize: number;
21
- };
22
- buildFromTree(tree: unknown, path?: Path): void;
23
- private pathToString;
24
- private collectDescendants;
25
- }
@@ -1,12 +0,0 @@
1
- export type PathNotifierInterceptor = (value: unknown, prev: unknown, path: string) => {
2
- block?: boolean;
3
- transform?: unknown;
4
- };
5
-
6
- export interface PathNotifier {
7
- subscribe(pattern: string, handler: (value: unknown, prev: unknown, path: string) => void): () => void;
8
- intercept(pattern: string, fn: PathNotifierInterceptor): () => void;
9
- notify(path: string, value: unknown, prev: unknown): void;
10
- }
11
-
12
- export function getPathNotifier(): PathNotifier;
package/src/presets.d.ts DELETED
@@ -1,11 +0,0 @@
1
- import type { TreeConfig } from '../../../lib/types';
2
- export type TreePreset = 'basic' | 'performance' | 'development' | 'production';
3
- export declare const TREE_PRESETS: Record<TreePreset, Partial<TreeConfig>>;
4
- export declare function createPresetConfig(preset: TreePreset, overrides?: Partial<TreeConfig>): TreeConfig;
5
- export declare function validatePreset(preset: TreePreset): boolean;
6
- export declare function getAvailablePresets(): TreePreset[];
7
- export declare function combinePresets(presets: TreePreset[], overrides?: Partial<TreeConfig>): TreeConfig;
8
- export declare function createDevTree(overrides?: Partial<TreeConfig>): {
9
- readonly config: TreeConfig;
10
- readonly enhancer: (tree: import("../../memoization/lib/memoization").MemoizedSignalTree<unknown>) => import("../../memoization/lib/memoization").MemoizedSignalTree<unknown>;
11
- };
@@ -1,33 +0,0 @@
1
- export type SecurityEventType = 'dangerous-key-blocked' | 'xss-attempt-blocked' | 'function-value-blocked' | 'validation-error';
2
- export interface SecurityEvent {
3
- type: SecurityEventType;
4
- key?: string;
5
- value?: unknown;
6
- reason: string;
7
- timestamp: number;
8
- }
9
- export interface SecurityValidatorConfig {
10
- preventPrototypePollution?: boolean;
11
- preventXSS?: boolean;
12
- preventFunctions?: boolean;
13
- customDangerousKeys?: string[];
14
- onSecurityEvent?: (event: SecurityEvent) => void;
15
- sanitizationMode?: 'strict' | 'permissive';
16
- }
17
- export declare class SecurityValidator {
18
- private readonly config;
19
- private readonly dangerousKeys;
20
- constructor(config?: SecurityValidatorConfig);
21
- validateKey(key: string): void;
22
- validateValue<T>(value: T): T;
23
- private sanitize;
24
- validateKeyValue<T>(key: string, value: T): T;
25
- isDangerousKey(key: string): boolean;
26
- getConfig(): Readonly<Required<SecurityValidatorConfig>>;
27
- }
28
- export declare const SecurityPresets: {
29
- strict: () => SecurityValidator;
30
- standard: () => SecurityValidator;
31
- permissive: () => SecurityValidator;
32
- disabled: () => SecurityValidator;
33
- };
@@ -1,8 +0,0 @@
1
- import type { SignalTree, TreeConfig, TreePreset, EnhancerWithMeta, NodeAccessor } from './types';
2
- export declare function isNodeAccessor(value: unknown): value is NodeAccessor<unknown>;
3
- export declare function signalTree<T>(obj: T): SignalTree<T>;
4
- export declare function signalTree<T>(obj: T, preset: TreePreset): SignalTree<T>;
5
- export declare function signalTree<T>(obj: T, config: TreeConfig): SignalTree<T>;
6
- export declare function signalTree<T extends Record<string, unknown>>(obj: Required<T>, configOrPreset?: TreeConfig | TreePreset): SignalTree<Required<T>>;
7
- export declare function signalTree<T>(obj: T, configOrPreset?: TreeConfig | TreePreset): SignalTree<T>;
8
- export declare function applyEnhancer<T, O>(tree: SignalTree<T>, enhancer: EnhancerWithMeta<SignalTree<T>, O>): O;
@@ -1,3 +0,0 @@
1
- import '@angular/compiler';
2
- import 'zone.js';
3
- import 'zone.js/testing';
@@ -1,36 +0,0 @@
1
- import type { SignalTree } from '../../../lib/types';
2
- export interface TimeTravelEntry<T> {
3
- state: T;
4
- timestamp: number;
5
- action: string;
6
- payload?: unknown;
7
- }
8
- export interface TimeTravelInterface<T> {
9
- undo(): boolean;
10
- redo(): boolean;
11
- getHistory(): TimeTravelEntry<T>[];
12
- resetHistory(): void;
13
- jumpTo(index: number): boolean;
14
- getCurrentIndex(): number;
15
- canUndo(): boolean;
16
- canRedo(): boolean;
17
- }
18
- export interface TimeTravelConfig {
19
- maxHistorySize?: number;
20
- includePayload?: boolean;
21
- actionNames?: {
22
- update?: string;
23
- set?: string;
24
- batch?: string;
25
- [key: string]: string | undefined;
26
- };
27
- }
28
- export declare function withTimeTravel<T>(config?: TimeTravelConfig): (tree: SignalTree<T>) => SignalTree<T> & {
29
- __timeTravel: TimeTravelInterface<T>;
30
- };
31
- export declare function enableTimeTravel<T>(maxHistorySize?: number): (tree: SignalTree<T>) => SignalTree<T> & {
32
- __timeTravel: TimeTravelInterface<T>;
33
- };
34
- export declare function getTimeTravel<T>(tree: SignalTree<T> & {
35
- __timeTravel?: TimeTravelInterface<T>;
36
- }): TimeTravelInterface<T> | undefined;