@katn30/trakr 2.2.1 → 4.0.0

package/dist/dev/index.d.cts

@@ -221,6 +221,10 @@ interface IdAssignment {
     value: number;
 }
 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;
@@ -414,4 +418,91 @@ declare function Tracked(validator?: (self: any, newValue: any) => string | unde
     <T extends TrackedObject, V>(target: (this: T) => V, context: ClassGetterDecoratorContext<T, V>): (this: T) => V;
 };
 
-export { AutoId, type ITracked, type IdAssignment, type PropertyScope, State, Tracked, TrackedCollection, TrackedCollectionChanged, TrackedObject, type TrackedPropertyChanged, Tracker, TrackerSession, TypedEvent };
+interface GeneratedEvent<TEventType extends string = string, TPayload = Record<string, unknown>> {
+    eventType: TEventType;
+    payload: TPayload;
+    trackingId?: number;
+    targetId?: unknown;
+}
+interface EventLifecycleOptions<TEventType extends string = string> {
+    itemAdded?: TEventType;
+    itemRemoved?: TEventType;
+}
+
+declare class EventTracker extends Tracker {
+    withContext<T>(ctx: unknown, action: () => T): T;
+    onCommit(keys?: IdAssignment[]): void;
+    generateEvents<TEventType extends string = string>(): GeneratedEvent<TEventType>[];
+}
+
+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;
+    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 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

@@ -221,6 +221,10 @@ interface IdAssignment {
     value: number;
 }
 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;
@@ -414,4 +418,91 @@ declare function Tracked(validator?: (self: any, newValue: any) => string | unde
     <T extends TrackedObject, V>(target: (this: T) => V, context: ClassGetterDecoratorContext<T, V>): (this: T) => V;
 };
 
-export { AutoId, type ITracked, type IdAssignment, type PropertyScope, State, Tracked, TrackedCollection, TrackedCollectionChanged, TrackedObject, type TrackedPropertyChanged, Tracker, TrackerSession, TypedEvent };
+interface GeneratedEvent<TEventType extends string = string, TPayload = Record<string, unknown>> {
+    eventType: TEventType;
+    payload: TPayload;
+    trackingId?: number;
+    targetId?: unknown;
+}
+interface EventLifecycleOptions<TEventType extends string = string> {
+    itemAdded?: TEventType;
+    itemRemoved?: TEventType;
+}
+
+declare class EventTracker extends Tracker {
+    withContext<T>(ctx: unknown, action: () => T): T;
+    onCommit(keys?: IdAssignment[]): void;
+    generateEvents<TEventType extends string = string>(): GeneratedEvent<TEventType>[];
+}
+
+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;
+    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 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 };