ee37734cfc
* Introduce snapshot class to track snapshot updates This avoids the hassle of having to manually call emit. * Better viewmodel ergonomics - Rename `SubscriptionViewModel` to `BaseViewModel`. I feel this is appropriate since that class does more than just manage subscriptions. - `getSnapshot` is no longer an abstract method. It's simply a method that returns the current snapshot state. This ensures that getSnapshot result is cached by default which is required by `useSyncExternalStore`. - `props` are a property of the base vm class so that actual VMs don't have to keep creating this property. * Update `TextualEventViewModel` * Fix test * Rename `TextualEvent` to `TextualEventView` * Fix snapshot object not being merged * Rename directory to `EventTileView` * Fix broken snapshot * Add test for snapshot class
44 lines
1.1 KiB
TypeScript
44 lines
1.1 KiB
TypeScript
/*
|
|
Copyright 2025 New Vector Ltd.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
/**
|
|
* This is the output of the viewmodel that the view consumes.
|
|
* Updating snapshot through this object will make react re-render
|
|
* components.
|
|
*/
|
|
export class Snapshot<T> {
|
|
public constructor(
|
|
private snapshot: T,
|
|
private emit: () => void,
|
|
) {}
|
|
|
|
/**
|
|
* Replace current snapshot with a new snapshot value.
|
|
* @param snapshot New snapshot value
|
|
*/
|
|
public set(snapshot: T): void {
|
|
this.snapshot = snapshot;
|
|
this.emit();
|
|
}
|
|
|
|
/**
|
|
* Update a part of the current snapshot by merging into the existing snapshot.
|
|
* @param snapshot A subset of the snapshot to merge into the current snapshot.
|
|
*/
|
|
public merge(snapshot: Partial<T>): void {
|
|
this.snapshot = { ...this.snapshot, ...snapshot };
|
|
this.emit();
|
|
}
|
|
|
|
/**
|
|
* The current value of the snapshot.
|
|
*/
|
|
public get current(): T {
|
|
return this.snapshot;
|
|
}
|
|
}
|