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.
54 lines
1.7 KiB
TypeScript
54 lines
1.7 KiB
TypeScript
import { AdvancedCameraCardError, Message } from '../../types';
|
|
import { dispatchAdvancedCameraCardEvent } from '../../utils/basic';
|
|
|
|
// Facilitates correct typing of event handlers.
|
|
export interface AdvancedCameraCardMessageEventTarget extends EventTarget {
|
|
addEventListener(
|
|
event: 'advanced-camera-card:message',
|
|
listener: (
|
|
this: AdvancedCameraCardMessageEventTarget,
|
|
ev: CustomEvent<Message>,
|
|
) => void,
|
|
options?: AddEventListenerOptions | boolean,
|
|
): void;
|
|
addEventListener(
|
|
type: string,
|
|
callback: EventListenerOrEventListenerObject,
|
|
options?: AddEventListenerOptions | boolean,
|
|
): void;
|
|
removeEventListener(
|
|
event: 'advanced-camera-card:message',
|
|
listener: (
|
|
this: AdvancedCameraCardMessageEventTarget,
|
|
ev: CustomEvent<Message>,
|
|
) => void,
|
|
options?: boolean | EventListenerOptions,
|
|
): void;
|
|
removeEventListener(
|
|
type: string,
|
|
callback: EventListenerOrEventListenerObject,
|
|
options?: boolean | EventListenerOptions,
|
|
): void;
|
|
}
|
|
|
|
/**
|
|
* Dispatch an event with an error message to show to the user. Calling this
|
|
* method will grind the card to a halt, so should only be used for "global" /
|
|
* critical errors (i.e. not for individual errors with a given camera, since
|
|
* there may be multiple correctly functioning cameras in a grid).
|
|
* @param element The element to send the event.
|
|
* @param message The message to show.
|
|
*/
|
|
export const dispatchAdvancedCameraCardErrorEvent = (
|
|
element: EventTarget,
|
|
error: unknown,
|
|
): void => {
|
|
if (error instanceof Error) {
|
|
dispatchAdvancedCameraCardEvent<Message>(element, 'message', {
|
|
message: error.message,
|
|
type: 'error',
|
|
...(error instanceof AdvancedCameraCardError && { context: error.context }),
|
|
});
|
|
}
|
|
};
|