Dermot Duffy
cc376a8be1
Whilst the Frigate support in this card is the best among camera engines, the name incorrectly suggests that Frigate is a requirement. Instead, to broaden the appeal, change to more camera agnostic name. This does not suggest any change in priority, role or support for Frigate. This change is likely to be bug prone, due to the size of the rename -- the code contains 1500+ references to "Frigate" most of which make sense to rename, some which do not, all of which needed human assessment. - Closes #1298 BREAKING CHANGE: References to `frigate-card` in all kinds of configuration need to be updated to `advanced-camera-card`. An automated config upgrade should take care of the majority of usecases (click `Edit -> Upgrade -> Save`), though may not be perfect.
89 lines
2.3 KiB
TypeScript
89 lines
2.3 KiB
TypeScript
import { AdvancedCameraCardError, Message, MessageType } from '../types';
|
|
import { errorToConsole } from '../utils/basic';
|
|
import { CardMessageAPI } from './types';
|
|
|
|
type MessagePriority = {
|
|
[type in MessageType]: number;
|
|
};
|
|
|
|
const MESSAGE_TYPE_PRIORITIES: MessagePriority = {
|
|
info: 10,
|
|
error: 20,
|
|
connection: 30,
|
|
diagnostics: 40,
|
|
};
|
|
|
|
export class MessageManager {
|
|
protected _message: Message | null = null;
|
|
protected _api: CardMessageAPI;
|
|
|
|
constructor(api: CardMessageAPI) {
|
|
this._api = api;
|
|
}
|
|
|
|
public getMessage(): Message | null {
|
|
return this._message;
|
|
}
|
|
|
|
public hasMessage(): boolean {
|
|
return !!this._message;
|
|
}
|
|
|
|
public hasErrorMessage(): boolean {
|
|
return this._message?.type === 'error';
|
|
}
|
|
|
|
public reset(): void {
|
|
const hadMessage = this.hasMessage();
|
|
this._message = null;
|
|
|
|
if (hadMessage) {
|
|
this._api.getCardElementManager().update();
|
|
}
|
|
}
|
|
|
|
public resetType(type: MessageType): void {
|
|
if (this._message?.type === type) {
|
|
this.reset();
|
|
}
|
|
}
|
|
|
|
public setErrorIfHigherPriority(error: unknown, prefix?: string): void {
|
|
// This object should accept unknown objects to be able to seamlessly
|
|
// process arguments to catch() which can only be unknown/any. HA may throw
|
|
// non Error() based errors.
|
|
if (!error || typeof error !== 'object' || !('message' in error)) {
|
|
return;
|
|
}
|
|
|
|
errorToConsole(error);
|
|
this.setMessageIfHigherPriority({
|
|
message: prefix ? `${prefix}: ${error.message}` : String(error.message),
|
|
type: 'error',
|
|
...(error instanceof AdvancedCameraCardError && { context: error.context }),
|
|
});
|
|
}
|
|
|
|
public setMessageIfHigherPriority(message: Message): boolean {
|
|
const resolveMessageType = (message: Message): MessageType => {
|
|
return message.type ?? 'info';
|
|
};
|
|
const currentPriority = this._message
|
|
? MESSAGE_TYPE_PRIORITIES[resolveMessageType(this._message)]
|
|
: 0;
|
|
const newPriority = MESSAGE_TYPE_PRIORITIES[resolveMessageType(message)];
|
|
|
|
if (this._message && newPriority < currentPriority) {
|
|
return false;
|
|
}
|
|
|
|
this._message = message;
|
|
|
|
// When a message is displayed it effectively unloads the media.
|
|
this._api.getMediaLoadedInfoManager().clear();
|
|
this._api.getCardElementManager().scrollReset();
|
|
this._api.getCardElementManager().update();
|
|
return true;
|
|
}
|
|
}
|