@katn30/trakr 3.0.0 → 4.1.0

package/dist/dev/index.d.cts

@@ -216,11 +216,15 @@ declare global {
     }
 }
 
-interface IdAssignment {
+interface IdAssignment<V = number> {
     trackingId: number;
-    value: number;
+    value: V;
 }
 declare function AutoId<This extends object, Value>(_target: undefined, context: ClassFieldDecoratorContext<This, Value>): void;
+declare function Id<This extends object, Value>(_target: undefined, context: ClassFieldDecoratorContext<This, Value>): void;
+declare function getIdentityProperties(proto: object): string[];
+declare function getIdentity(obj: object): unknown;
+declare function getIdentityObject(obj: object): Record<string, unknown>;
 
 interface StateTarget {
     trackingId: number;
@@ -261,7 +265,7 @@ declare abstract class TrackedObject implements ITracked, StateTarget {
     protected set dirtyCounter(value: number);
     constructor(tracker: Tracker);
     /** @internal */
-    _onCommitted(lastOp?: Operation, keys?: IdAssignment[]): void;
+    _onCommitted(lastOp?: Operation, keys?: IdAssignment<unknown>[]): void;
     /** @internal */
     _markRemoved(): void;
     /** @internal */
@@ -394,7 +398,8 @@ declare class Tracker implements ITrackerContext {
     private lastActionIsRecent;
     /** @internal */
     _nextTrackingId(): number;
-    onCommit(keys?: IdAssignment[]): void;
+    onCommit<V = number>(keys?: IdAssignment<V>[]): void;
+    getByTrackingId(trackingId: number): TrackedObject | undefined;
     /** @internal */
     _isInUndoStack(op: Operation): boolean;
     private reset;
@@ -418,7 +423,7 @@ interface GeneratedEvent<TEventType extends string = string, TPayload = Record<s
     eventType: TEventType;
     payload: TPayload;
     trackingId?: number;
-    targetId?: number;
+    targetId?: unknown;
 }
 interface EventLifecycleOptions<TEventType extends string = string> {
     itemAdded?: TEventType;
@@ -426,23 +431,79 @@ interface EventLifecycleOptions<TEventType extends string = string> {
 }
 
 declare class EventTracker extends Tracker {
-    onCommit(keys?: IdAssignment[]): void;
+    withContext<T>(ctx: unknown, action: () => T): T;
+    onCommit<V = number>(keys?: IdAssignment<V>[]): void;
     generateEvents<TEventType extends string = string>(): GeneratedEvent<TEventType>[];
 }
 
-declare function EventTracked(eventType: string, validator?: (self: any, newValue: any) => string | undefined, onChange?: (self: any, newValue: any, oldValue: any) => void, options?: {
+interface HistoryOptions<TSelf = any, TValue = any> {
+    entryFactory: (self: TSelf, newValue: TValue, oldValue: TValue, change: Change, ctx?: unknown) => unknown;
+}
+type HistoryConfig = boolean | HistoryOptions;
+interface EventPropertyOptions {
+    eventType?: string;
+    history?: HistoryConfig;
     coalesceWithin?: number;
-}): {
+}
+
+interface EventTrackedOptions {
+    coalesceWithin?: number;
+    eventType?: string;
+    history?: HistoryConfig;
+}
+declare function EventTracked(validator?: (self: any, newValue: any) => string | undefined, onChange?: (self: any, newValue: any, oldValue: any) => void, options?: EventTrackedOptions): {
     <T extends TrackedObject, V>(target: ClassAccessorDecoratorTarget<T, V>, context: ClassAccessorDecoratorContext<T, V>): ClassAccessorDecoratorResult<T, V>;
     <T extends TrackedObject, V>(target: (this: T, value: V) => void, context: ClassSetterDecoratorContext<T, V>): (this: T, value: V) => void;
     <T extends TrackedObject, V>(target: (this: T) => V, context: ClassGetterDecoratorContext<T, V>): (this: T) => V;
 };
 
+interface CollectionHistoryOptions<T = any> {
+    entryFactory: (self: T, change: Change, ctx?: unknown) => unknown;
+}
+type CollectionHistoryConfig = boolean | CollectionHistoryOptions;
+interface EventTrackedCollectionOptions<T = any, TEventType extends string = string> extends EventLifecycleOptions<TEventType> {
+    eventType?: TEventType;
+    history?: CollectionHistoryConfig;
+    owner?: {
+        object: TrackedObject;
+        property: string;
+    };
+}
+interface CollectionOp {
+    op: "add" | "remove" | "change";
+    item?: TrackedObject;
+    identity?: unknown;
+    diff?: Record<string, unknown>;
+    raw?: unknown;
+    snapshot?: Record<string, unknown>;
+}
 declare class EventTrackedCollection<T, TEventType extends string = string> extends TrackedCollection<T> {
     private readonly _eventOptions;
-    constructor(tracker: Tracker, items?: T[], validator?: (value: T[]) => string | undefined, eventOptions?: EventLifecycleOptions<TEventType>);
+    private readonly _historyOps;
+    private readonly _baselineItems;
+    constructor(tracker: Tracker, items?: T[], validator?: (value: T[]) => string | undefined, options?: EventTrackedCollectionOptions<T, TEventType>);
     /** @internal */
     get _lifecycleOptions(): EventLifecycleOptions<TEventType> | undefined;
+    /** @internal */
+    get _aggregateOptions(): EventTrackedCollectionOptions<T, TEventType> | undefined;
+    /** @internal */
+    get _historyOpsList(): CollectionOp[];
+    /** @internal */
+    _clearHistoryOps(): void;
+    /** @internal */
+    _isInBaseline(item: T): boolean;
+    /** @internal */
+    _baselineListSnapshot(): T[];
+    /** @internal */
+    _rebaseline(): void;
+    private _isAggregateMode;
+    private _isHistoryMode;
+    private _validateItemHasIdentity;
+    private _attachItemChangeWatchers;
+    private _recordAddOp;
+    private _recordRemoveOp;
+    private _recordChangeOpDiff;
+    private _recordChangeOp;
 }
 
-export { AutoId, type EventLifecycleOptions, EventTracked, EventTrackedCollection, EventTracker, type GeneratedEvent, type ITracked, type IdAssignment, type PropertyScope, State, Tracked, TrackedCollection, TrackedCollectionChanged, TrackedObject, type TrackedPropertyChanged, Tracker, TrackerSession, TypedEvent };
+export { AutoId, type CollectionHistoryConfig, type CollectionHistoryOptions, type EventLifecycleOptions, type EventPropertyOptions, EventTracked, EventTrackedCollection, type EventTrackedCollectionOptions, type EventTrackedOptions, EventTracker, type GeneratedEvent, type HistoryConfig, type HistoryOptions, type ITracked, Id, type IdAssignment, type PropertyScope, State, Tracked, TrackedCollection, TrackedCollectionChanged, TrackedObject, type TrackedPropertyChanged, Tracker, TrackerSession, TypedEvent, getIdentity, getIdentityObject, getIdentityProperties };

package/dist/dev/index.d.ts

@@ -216,11 +216,15 @@ declare global {
     }
 }
 
-interface IdAssignment {
+interface IdAssignment<V = number> {
     trackingId: number;
-    value: number;
+    value: V;
 }
 declare function AutoId<This extends object, Value>(_target: undefined, context: ClassFieldDecoratorContext<This, Value>): void;
+declare function Id<This extends object, Value>(_target: undefined, context: ClassFieldDecoratorContext<This, Value>): void;
+declare function getIdentityProperties(proto: object): string[];
+declare function getIdentity(obj: object): unknown;
+declare function getIdentityObject(obj: object): Record<string, unknown>;
 
 interface StateTarget {
     trackingId: number;
@@ -261,7 +265,7 @@ declare abstract class TrackedObject implements ITracked, StateTarget {
     protected set dirtyCounter(value: number);
     constructor(tracker: Tracker);
     /** @internal */
-    _onCommitted(lastOp?: Operation, keys?: IdAssignment[]): void;
+    _onCommitted(lastOp?: Operation, keys?: IdAssignment<unknown>[]): void;
     /** @internal */
     _markRemoved(): void;
     /** @internal */
@@ -394,7 +398,8 @@ declare class Tracker implements ITrackerContext {
     private lastActionIsRecent;
     /** @internal */
     _nextTrackingId(): number;
-    onCommit(keys?: IdAssignment[]): void;
+    onCommit<V = number>(keys?: IdAssignment<V>[]): void;
+    getByTrackingId(trackingId: number): TrackedObject | undefined;
     /** @internal */
     _isInUndoStack(op: Operation): boolean;
     private reset;
@@ -418,7 +423,7 @@ interface GeneratedEvent<TEventType extends string = string, TPayload = Record<s
     eventType: TEventType;
     payload: TPayload;
     trackingId?: number;
-    targetId?: number;
+    targetId?: unknown;
 }
 interface EventLifecycleOptions<TEventType extends string = string> {
     itemAdded?: TEventType;
@@ -426,23 +431,79 @@ interface EventLifecycleOptions<TEventType extends string = string> {
 }
 
 declare class EventTracker extends Tracker {
-    onCommit(keys?: IdAssignment[]): void;
+    withContext<T>(ctx: unknown, action: () => T): T;
+    onCommit<V = number>(keys?: IdAssignment<V>[]): void;
     generateEvents<TEventType extends string = string>(): GeneratedEvent<TEventType>[];
 }
 
-declare function EventTracked(eventType: string, validator?: (self: any, newValue: any) => string | undefined, onChange?: (self: any, newValue: any, oldValue: any) => void, options?: {
+interface HistoryOptions<TSelf = any, TValue = any> {
+    entryFactory: (self: TSelf, newValue: TValue, oldValue: TValue, change: Change, ctx?: unknown) => unknown;
+}
+type HistoryConfig = boolean | HistoryOptions;
+interface EventPropertyOptions {
+    eventType?: string;
+    history?: HistoryConfig;
     coalesceWithin?: number;
-}): {
+}
+
+interface EventTrackedOptions {
+    coalesceWithin?: number;
+    eventType?: string;
+    history?: HistoryConfig;
+}
+declare function EventTracked(validator?: (self: any, newValue: any) => string | undefined, onChange?: (self: any, newValue: any, oldValue: any) => void, options?: EventTrackedOptions): {
     <T extends TrackedObject, V>(target: ClassAccessorDecoratorTarget<T, V>, context: ClassAccessorDecoratorContext<T, V>): ClassAccessorDecoratorResult<T, V>;
     <T extends TrackedObject, V>(target: (this: T, value: V) => void, context: ClassSetterDecoratorContext<T, V>): (this: T, value: V) => void;
     <T extends TrackedObject, V>(target: (this: T) => V, context: ClassGetterDecoratorContext<T, V>): (this: T) => V;
 };
 
+interface CollectionHistoryOptions<T = any> {
+    entryFactory: (self: T, change: Change, ctx?: unknown) => unknown;
+}
+type CollectionHistoryConfig = boolean | CollectionHistoryOptions;
+interface EventTrackedCollectionOptions<T = any, TEventType extends string = string> extends EventLifecycleOptions<TEventType> {
+    eventType?: TEventType;
+    history?: CollectionHistoryConfig;
+    owner?: {
+        object: TrackedObject;
+        property: string;
+    };
+}
+interface CollectionOp {
+    op: "add" | "remove" | "change";
+    item?: TrackedObject;
+    identity?: unknown;
+    diff?: Record<string, unknown>;
+    raw?: unknown;
+    snapshot?: Record<string, unknown>;
+}
 declare class EventTrackedCollection<T, TEventType extends string = string> extends TrackedCollection<T> {
     private readonly _eventOptions;
-    constructor(tracker: Tracker, items?: T[], validator?: (value: T[]) => string | undefined, eventOptions?: EventLifecycleOptions<TEventType>);
+    private readonly _historyOps;
+    private readonly _baselineItems;
+    constructor(tracker: Tracker, items?: T[], validator?: (value: T[]) => string | undefined, options?: EventTrackedCollectionOptions<T, TEventType>);
     /** @internal */
     get _lifecycleOptions(): EventLifecycleOptions<TEventType> | undefined;
+    /** @internal */
+    get _aggregateOptions(): EventTrackedCollectionOptions<T, TEventType> | undefined;
+    /** @internal */
+    get _historyOpsList(): CollectionOp[];
+    /** @internal */
+    _clearHistoryOps(): void;
+    /** @internal */
+    _isInBaseline(item: T): boolean;
+    /** @internal */
+    _baselineListSnapshot(): T[];
+    /** @internal */
+    _rebaseline(): void;
+    private _isAggregateMode;
+    private _isHistoryMode;
+    private _validateItemHasIdentity;
+    private _attachItemChangeWatchers;
+    private _recordAddOp;
+    private _recordRemoveOp;
+    private _recordChangeOpDiff;
+    private _recordChangeOp;
 }
 
-export { AutoId, type EventLifecycleOptions, EventTracked, EventTrackedCollection, EventTracker, type GeneratedEvent, type ITracked, type IdAssignment, type PropertyScope, State, Tracked, TrackedCollection, TrackedCollectionChanged, TrackedObject, type TrackedPropertyChanged, Tracker, TrackerSession, TypedEvent };
+export { AutoId, type CollectionHistoryConfig, type CollectionHistoryOptions, type EventLifecycleOptions, type EventPropertyOptions, EventTracked, EventTrackedCollection, type EventTrackedCollectionOptions, type EventTrackedOptions, EventTracker, type GeneratedEvent, type HistoryConfig, type HistoryOptions, type ITracked, Id, type IdAssignment, type PropertyScope, State, Tracked, TrackedCollection, TrackedCollectionChanged, TrackedObject, type TrackedPropertyChanged, Tracker, TrackerSession, TypedEvent, getIdentity, getIdentityObject, getIdentityProperties };