Files
advanced-camera-card/tests/config/management.test.ts
T

3437 lines
95 KiB
TypeScript

import {
CallServiceActionConfig,
PerformActionActionConfig,
} from '@dermotduffy/custom-card-helpers';
import { describe, expect, it } from 'vitest';
import {
copyConfig,
createRangedTransform,
deleteConfigValue,
deleteTransform,
deleteWithOverrides,
getArrayConfigPath,
getConfigValue,
isConfigUpgradeable,
moveConfigValue,
setConfigValue,
upgradeArrayOfObjects,
upgradeConfig,
upgradeMoveTo,
upgradeMoveToWithOverrides,
upgradeObjectRecursively,
upgradeWithOverrides,
} from '../../src/config/management';
import { PTZControlAction } from '../../src/config/ptz';
import {
Actions,
RawFrigateCardConfig,
frigateCardConfigSchema,
} from '../../src/config/types';
import { getParseErrorPaths } from '../../src/utils/zod';
describe('general functions', () => {
it('should set value', () => {
const target = {};
setConfigValue(target, 'a', 10);
expect(target).toEqual({
a: 10,
});
});
describe('should get value', () => {
it('present', () => {
expect(getConfigValue({ b: 11 }, 'b')).toEqual(11);
});
it('absent', () => {
expect(getConfigValue({ b: 11 }, 'c')).toBeUndefined();
});
it('absent with default', () => {
expect(getConfigValue({ b: 11 }, 'c', 12)).toBe(12);
});
});
describe('should unset value', () => {
it('nested', () => {
const target = {
moo: {
foo: {
a: 10,
},
bar: {
b: 11,
},
},
};
deleteConfigValue(target, 'moo.foo');
expect(target).toEqual({ moo: { bar: { b: 11 } } });
});
it('top-level', () => {
const target = {
a: 10,
b: 11,
};
deleteConfigValue(target, 'a');
expect(target).toEqual({ b: 11 });
});
});
it('should copy config', () => {
const target = {
a: {
b: {
c: 10,
},
},
};
const copy = copyConfig(target);
expect(copy).toEqual(target);
expect(copy).not.toBe(target);
});
it('should get array config path', () => {
expect(getArrayConfigPath('a.#.b', 10)).toBe('a.[10].b');
});
});
describe('upgrade functions', () => {
it('should determine if config is upgradeable', () => {
expect(
// Upgrade example: rename of service_data to data.
isConfigUpgradeable({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'icon',
icon: 'mdi:cow',
style: {
right: '20px',
top: '20px',
color: 'white',
},
tap_action: {
action: 'call-service',
service: 'notify.persistent_notification',
service_data: {
message: 'Hello 1',
},
},
},
],
}),
).toBeTruthy();
});
describe('should create ranged transform', () => {
describe('with numbers', () => {
it('inside range', () => {
expect(createRangedTransform((val) => val, 10, 20)(11)).toBe(11);
});
it('outside range', () => {
expect(createRangedTransform((val) => val, 10, 20)(1)).toBe(10);
});
it('with a range', () => {
expect(createRangedTransform((val) => val)(100)).toBe(100);
});
});
it('with non-number', () => {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
expect(createRangedTransform((_val) => 'foo')(1)).toBe('foo');
});
});
it('should return null from delete property transform', () => {
expect(deleteTransform(10)).toBeNull();
});
describe('should move config value', () => {
it('simple', () => {
const config = {
foo: {
c: 10,
},
};
expect(moveConfigValue(config, 'foo', 'bar')).toBeTruthy();
expect(config).toEqual({
bar: {
c: 10,
},
});
});
describe('in place', () => {
it('non-transformed', () => {
const config = {
foo: {
c: 10,
},
};
expect(moveConfigValue(config, 'foo', 'foo')).toBeFalsy();
expect(config).toEqual({
foo: {
c: 10,
},
});
});
it('transformed', () => {
const config = {
foo: {
c: 10,
},
};
expect(
moveConfigValue(config, 'foo.c', 'foo.c', { transform: (val) => String(val) }),
).toBeTruthy();
expect(config).toEqual({
foo: {
c: '10',
},
});
});
});
describe('with transform result', () => {
it('move', () => {
const config = {
c: 10,
};
expect(
moveConfigValue(config, 'c', 'd', { transform: (val) => String(val) }),
).toBeTruthy();
expect(config).toEqual({ d: '10' });
});
it('keep original', () => {
const config = {
c: 10,
};
expect(
moveConfigValue(config, 'c', 'd', {
transform: (val) => String(val),
keepOriginal: true,
}),
).toBeTruthy();
expect(config).toEqual({ c: 10, d: '10' });
});
});
describe('with transform null result', () => {
it('remove', () => {
const config = {
c: 10,
};
expect(
// eslint-disable-next-line @typescript-eslint/no-unused-vars
moveConfigValue(config, 'c', 'd', { transform: (_val) => null }),
).toBeTruthy();
expect(config).toEqual({});
});
it('keep', () => {
const config = {
c: 10,
};
expect(
moveConfigValue(config, 'c', 'd', {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
transform: (_val) => null,
keepOriginal: true,
}),
).toBeFalsy();
expect(config).toEqual({ c: 10 });
});
});
it('with transform undefined result', () => {
const config = {
c: 10,
};
expect(
// eslint-disable-next-line @typescript-eslint/no-unused-vars
moveConfigValue(config, 'c', 'd', { transform: (_val) => undefined }),
).toBeFalsy();
expect(config).toEqual({ c: 10 });
});
});
it('should upgrade with a move', () => {
const config = {
c: 10,
};
expect(upgradeMoveTo('c', 'd')(config)).toBeTruthy();
expect(config).toEqual({ d: 10 });
});
it('should upgrade config and overrides with a move', () => {
const config = {
c: 10,
overrides: [
{
overrides: {
c: 10,
},
},
],
};
expect(upgradeMoveToWithOverrides('c', 'd')(config)).toBeTruthy();
expect(config).toEqual({ d: 10, overrides: [{ overrides: { d: 10 } }] });
});
it('should upgrade config and overrides in-place', () => {
const config = {
c: 10,
overrides: [
{
overrides: {
c: 10,
},
},
],
};
expect(upgradeWithOverrides('c', (val) => String(val))(config)).toBeTruthy();
expect(config).toEqual({ c: '10', overrides: [{ overrides: { c: '10' } }] });
});
describe('should upgrade array', () => {
it('in case of non-array', () => {
const config = { c: 10 };
// eslint-disable-next-line @typescript-eslint/no-unused-vars
expect(upgradeArrayOfObjects('c', (_val) => false)(config)).toBeFalsy();
});
it('in case of non-object items', () => {
const config = { c: [10, 11] };
// eslint-disable-next-line @typescript-eslint/no-unused-vars
expect(upgradeArrayOfObjects('c', (_val) => false)(config)).toBeFalsy();
});
it('in case of array', () => {
const config = { c: [{ d: 10 }, { d: 11 }] };
expect(
upgradeArrayOfObjects('c', (val) => {
val['e'] = 12;
return true;
})(config),
).toBeTruthy();
expect(config).toEqual({
c: [
{
d: 10,
e: 12,
},
{
d: 11,
e: 12,
},
],
});
});
});
describe('should recursively upgrade', () => {
it('ignoring simple objects', () => {
const config = { c: 10, d: 10 };
// eslint-disable-next-line @typescript-eslint/no-unused-vars
expect(upgradeObjectRecursively((_val) => false)(config)).toBeFalsy();
expect(config).toEqual({ c: 10, d: 10 });
});
it('iterating into arrays', () => {
const config = { values: [{ c: 10 }, { d: 10 }, 'random'] };
expect(
upgradeObjectRecursively((val) => {
if (!Array.isArray(val)) {
val['e'] = 11;
}
return true;
})(config),
).toBeTruthy();
expect(config).toEqual({
e: 11,
values: [{ c: 10, e: 11 }, { d: 10, e: 11 }, 'random'],
});
});
});
it('should have upgrades with bad input data', () => {
expect(upgradeConfig(3 as unknown as RawFrigateCardConfig)).toBeFalsy();
});
it('should delete properties', () => {
const config = { c: 10, d: 10 };
expect(deleteWithOverrides('c')(config)).toBeTruthy();
expect(config).toEqual({ d: 10 });
});
});
describe('should handle version specific upgrades', () => {
const postUpgradeChecks = (config: RawFrigateCardConfig): void => {
// Should be no additional upgrades.
expect(upgradeConfig(config)).toBeFalsy();
// Result should be parseable.
const result = frigateCardConfigSchema.safeParse(config);
if (!result.success) {
expect(
result.success,
'Post-upgrade parse error.\n\n' +
'Problem paths: ' +
[...getParseErrorPaths(result.error)] +
'\n\n' +
JSON.stringify(config, null, 2),
).toBeTruthy();
}
};
describe('v4.1.0', () => {
describe('should rename mediaLoaded to media_loaded', () => {
it('elements', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: {
mediaLoaded: true,
},
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: [
{
condition: 'media_loaded' as const,
media_loaded: true,
},
],
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
});
postUpgradeChecks(config);
});
it('overrides', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: {
mediaLoaded: true,
},
overrides: {
view: {
default: 'clips',
},
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: [
{
condition: 'media_loaded' as const,
media_loaded: true,
},
],
merge: {
view: {
default: 'clips',
},
},
},
],
});
postUpgradeChecks(config);
});
});
it('should rename event_gallery to media_gallery', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
event_gallery: {
foo: 'bar',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
media_gallery: {
foo: 'bar',
},
});
postUpgradeChecks(config);
});
it('should rename menu.buttons.frigate_ui to menu.buttons.camera_ui', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
menu: {
buttons: {
frigate_ui: {
foo: 'bar',
},
},
},
overrides: [
{
conditions: [
{
condition: 'view',
views: ['clips'],
},
],
overrides: {
menu: {
buttons: {
frigate_ui: {
foo: 'bar',
},
},
},
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
menu: {
buttons: {
camera_ui: {
foo: 'bar',
},
},
},
overrides: [
{
conditions: [
{
condition: 'view',
views: ['clips'],
},
],
merge: {
menu: {
buttons: {
camera_ui: {
foo: 'bar',
},
},
},
},
},
],
});
postUpgradeChecks(config);
});
it('should rename frigate ui actions', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'icon',
icon: 'mdi:cow',
tap_action: {
action: 'custom:frigate-card-action',
frigate_card_action: 'frigate_ui',
},
},
],
view: {
actions: {
double_tap_action: {
action: 'custom:frigate-card-action',
frigate_card_action: 'frigate_ui',
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'icon',
icon: 'mdi:cow',
tap_action: {
action: 'custom:frigate-card-action',
frigate_card_action: 'camera_ui',
},
},
],
view: {
actions: {
double_tap_action: {
action: 'custom:frigate-card-action',
frigate_card_action: 'camera_ui',
},
},
},
});
postUpgradeChecks(config);
});
describe('should rename frigate-jsmpeg provider to jsmpeg', () => {
it('in cameras', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ live_provider: 'ha' }, { live_provider: 'frigate-jsmpeg' }],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ live_provider: 'ha' }, { live_provider: 'jsmpeg' }],
});
postUpgradeChecks(config);
});
});
describe('should move live object into cameras_global', () => {
it.each([['image' as const], ['jsmpeg' as const], ['webrtc_card' as const]])(
'%s',
(objName: string) => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
[objName]: {
foo: 'bar',
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
cameras_global: {
[objName]: {
foo: 'bar',
},
},
live: {},
});
postUpgradeChecks(config);
},
);
});
describe('should convert to array and rename', () => {
it.each([['zone' as const], ['label' as const]])(`%s`, (objName: string) => {
const config = {
type: 'custom:frigate-card',
cameras: [
{ live_provider: 'ha', frigate: { [objName]: 'foo' } },
{ live_provider: 'jsmpeg' },
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [
{ live_provider: 'ha', frigate: { [objName + 's']: ['foo'] } },
{ live_provider: 'jsmpeg' },
],
});
postUpgradeChecks(config);
});
});
it('should convert and rename frigate.label to frigate.labels', () => {
const config = {
type: 'custom:frigate-card',
cameras: [
{ live_provider: 'ha', frigate: { zone: 'foo' } },
{ live_provider: 'jsmpeg' },
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [
{ live_provider: 'ha', frigate: { zones: ['foo'] } },
{ live_provider: 'jsmpeg' },
],
});
postUpgradeChecks(config);
});
});
describe('v5.2.0 -> v6.0.0', () => {
describe('should rename service_data to data', () => {
it('positive case', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'icon',
icon: 'mdi:cow',
style: {
right: '20px',
top: '20px',
color: 'white',
},
tap_action: {
action: 'call-service',
service: 'notify.persistent_notification',
service_data: {
message: 'Hello 1',
},
},
},
{
type: 'service-button',
title: 'title',
service: 'service',
service_data: {
message: "It's a trick",
},
},
],
view: {
actions: {
double_tap_action: {
action: 'call-service',
service: 'notify.persistent_notification',
service_data: {
message: 'Hello 2',
},
},
hold_action: {
action: 'call-service',
service: 'notify.persistent_notification',
data: {
message: 'Hello 3',
},
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'icon',
icon: 'mdi:cow',
style: {
right: '20px',
top: '20px',
color: 'white',
},
tap_action: {
action: 'perform-action',
perform_action: 'notify.persistent_notification',
data: {
message: 'Hello 1',
},
},
},
{
type: 'service-button',
title: 'title',
service: 'service',
// Trick: This *is* still called service_data in HA, so should not
// be modified.
service_data: {
message: "It's a trick",
},
},
],
view: {
actions: {
double_tap_action: {
action: 'perform-action',
perform_action: 'notify.persistent_notification',
data: {
message: 'Hello 2',
},
},
hold_action: {
action: 'perform-action',
perform_action: 'notify.persistent_notification',
data: {
message: 'Hello 3',
},
},
},
},
});
postUpgradeChecks(config);
});
it('negative case', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
view: {
default: 'live',
},
};
expect(upgradeConfig(config)).toBeFalsy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
view: {
default: 'live',
},
});
postUpgradeChecks(config);
});
});
describe('should move PTZ elements to live', () => {
it('case with 1 element', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:frigate-card-ptz',
orientation: 'vertical',
style: {
right: '20px',
top: '20px',
color: 'white',
},
actions_up: {
tap_action: {
action: 'call-service',
service: 'notify.persistent_notification',
service_data: {
message: 'Hello 1',
},
},
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
cameras: [{ camera_entity: 'camera.office' }],
cameras_global: {
ptz: {
actions_up: {
action: 'perform-action',
data: {
message: 'Hello 1',
},
perform_action: 'notify.persistent_notification',
},
},
},
live: {
controls: {
ptz: {
orientation: 'vertical',
style: {
color: 'white',
right: '20px',
top: '20px',
},
},
},
},
type: 'custom:frigate-card',
});
postUpgradeChecks(config);
});
it('case with >1 element', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:frigate-card-ptz',
orientation: 'vertical',
style: {
right: '20px',
top: '20px',
color: 'white',
},
actions_up: {
tap_action: {
action: 'call-service',
service: 'notify.persistent_notification',
service_data: {
message: 'Hello 1',
},
},
},
},
{
type: 'service-button',
title: 'title',
service: 'service',
service_data: {
message: "It's a trick",
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
cameras: [{ camera_entity: 'camera.office' }],
cameras_global: {
ptz: {
actions_up: {
action: 'perform-action',
data: {
message: 'Hello 1',
},
perform_action: 'notify.persistent_notification',
},
},
},
elements: [
{
service: 'service',
service_data: {
message: "It's a trick",
},
title: 'title',
type: 'service-button',
},
],
live: {
controls: {
ptz: {
orientation: 'vertical',
style: {
color: 'white',
right: '20px',
top: '20px',
},
},
},
},
type: 'custom:frigate-card',
});
postUpgradeChecks(config);
});
it('case with custom conditional element with 2 PTZ but nothing else', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:frigate-card-conditional',
conditions: {
fullscreen: true,
media_loaded: true,
},
elements: [
{
type: 'custom:frigate-card-ptz',
orientation: 'vertical',
style: {
right: '20px',
top: '20px',
color: 'white',
},
actions_up: {
tap_action: {
action: 'call-service',
service: 'notify.persistent_notification',
service_data: {
message: 'Hello 1',
},
},
},
},
{
type: 'custom:frigate-card-ptz',
orientation: 'vertical',
style: {
right: '20px',
top: '20px',
color: 'white',
},
actions_up: {
tap_action: {
action: 'call-service',
service: 'notify.persistent_notification',
service_data: {
message: 'Hello 2',
},
},
},
},
],
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
cameras: [{ camera_entity: 'camera.office' }],
cameras_global: {
ptz: {
actions_up: {
action: 'perform-action',
data: {
message: 'Hello 1',
},
perform_action: 'notify.persistent_notification',
},
},
},
live: {
controls: {
ptz: {
orientation: 'vertical',
style: {
color: 'white',
right: '20px',
top: '20px',
},
},
},
},
type: 'custom:frigate-card',
});
postUpgradeChecks(config);
});
it('case with custom conditional element with 1 PTZ and another element', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:frigate-card-conditional',
conditions: {
fullscreen: true,
media_loaded: true,
},
elements: [
{
type: 'service-button',
title: 'title',
service: 'service',
service_data: {
message: "It's a trick",
},
},
{
type: 'custom:frigate-card-ptz',
orientation: 'vertical',
style: {
right: '20px',
top: '20px',
color: 'white',
},
actions_up: {
tap_action: {
action: 'call-service',
service: 'notify.persistent_notification',
service_data: {
message: 'Hello 1',
},
},
},
},
],
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
cameras: [{ camera_entity: 'camera.office' }],
cameras_global: {
ptz: {
actions_up: {
action: 'perform-action',
data: {
message: 'Hello 1',
},
perform_action: 'notify.persistent_notification',
},
},
},
live: {
controls: {
ptz: {
orientation: 'vertical',
style: {
color: 'white',
right: '20px',
top: '20px',
},
},
},
},
elements: [
{
type: 'custom:frigate-card-conditional',
conditions: [
{
condition: 'fullscreen' as const,
fullscreen: true,
},
{
condition: 'media_loaded' as const,
media_loaded: true,
},
],
elements: [
{
type: 'service-button',
title: 'title',
service: 'service',
service_data: {
message: "It's a trick",
},
},
],
},
],
type: 'custom:frigate-card',
});
postUpgradeChecks(config);
});
it('case with stock conditional element with 1 PTZ', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'conditional',
conditions: [{ entity: 'light.office', state: 'on' }],
elements: [
{
type: 'custom:frigate-card-ptz',
orientation: 'vertical',
style: {
right: '20px',
top: '20px',
color: 'white',
},
actions_up: {
tap_action: {
action: 'call-service',
service: 'notify.persistent_notification',
service_data: {
message: 'Hello 1',
},
},
},
},
],
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
cameras: [{ camera_entity: 'camera.office' }],
cameras_global: {
ptz: {
actions_up: {
action: 'perform-action',
data: {
message: 'Hello 1',
},
perform_action: 'notify.persistent_notification',
},
},
},
live: {
controls: {
ptz: {
orientation: 'vertical',
style: {
color: 'white',
right: '20px',
top: '20px',
},
},
},
},
type: 'custom:frigate-card',
});
postUpgradeChecks(config);
});
it('case when live.controls.ptz already exists', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
live: {
controls: {
ptz: {
actions_up: {
tap_action: {
action: 'call-service',
data: {
message: 'Original',
},
service: 'notify.persistent_notification',
},
},
orientation: 'vertical',
style: {
color: 'white',
right: '20px',
top: '20px',
},
},
},
},
elements: [
{
type: 'custom:frigate-card-ptz',
orientation: 'vertical',
style: {
right: '20px',
top: '20px',
color: 'white',
},
actions_up: {
tap_action: {
action: 'call-service',
service: 'notify.persistent_notification',
service_data: {
message: 'Replacement that should be ignored',
},
},
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
cameras: [{ camera_entity: 'camera.office' }],
cameras_global: {
ptz: {
actions_up: {
action: 'perform-action',
data: {
message: 'Original',
},
perform_action: 'notify.persistent_notification',
},
},
},
live: {
controls: {
ptz: {
orientation: 'vertical',
style: {
color: 'white',
right: '20px',
top: '20px',
},
},
},
},
type: 'custom:frigate-card',
});
postUpgradeChecks(config);
});
});
it('should move view.timeout_seconds', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
view: {
timeout_seconds: 200,
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
view: {
interaction_seconds: 200,
},
});
postUpgradeChecks(config);
});
describe('should handle all and never action conditions', () => {
describe('live', () => {
describe('lazy_unload', () => {
it('all', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
lazy_unload: 'all',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
lazy_unload: ['unselected', 'hidden'],
},
});
postUpgradeChecks(config);
});
it('never', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
lazy_unload: 'never',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {},
});
postUpgradeChecks(config);
});
it('other value', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
lazy_unload: 'unselected',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
lazy_unload: ['unselected'],
},
});
postUpgradeChecks(config);
});
});
describe('auto_play', () => {
it('all', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_play: 'all',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {},
});
postUpgradeChecks(config);
});
it('never', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_play: 'never',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_play: [],
},
});
postUpgradeChecks(config);
});
it('other value', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_play: 'selected',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_play: ['selected'],
},
});
postUpgradeChecks(config);
});
});
describe('auto_pause', () => {
it('all', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_pause: 'all',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_pause: ['unselected', 'hidden'],
},
});
postUpgradeChecks(config);
});
it('never', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_pause: 'never',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {},
});
postUpgradeChecks(config);
});
it('other value', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_pause: 'unselected',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_pause: ['unselected'],
},
});
postUpgradeChecks(config);
});
});
describe('auto_mute', () => {
it('all', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_mute: 'all',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {},
});
postUpgradeChecks(config);
});
it('never', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_mute: 'never',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_mute: [],
},
});
postUpgradeChecks(config);
});
it('other value', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_mute: 'unselected',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_mute: ['unselected'],
},
});
postUpgradeChecks(config);
});
});
describe('auto_unmute', () => {
it('all', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_unmute: 'all',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_unmute: ['selected', 'visible', 'microphone'],
},
});
postUpgradeChecks(config);
});
it('never', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_unmute: 'never',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {},
});
postUpgradeChecks(config);
});
it('other value', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_unmute: 'selected',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
auto_unmute: ['selected'],
},
});
postUpgradeChecks(config);
});
});
});
describe('media_viewer', () => {
describe('auto_play', () => {
it('all', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_play: 'all',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {},
});
postUpgradeChecks(config);
});
it('never', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_play: 'never',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_play: [],
},
});
postUpgradeChecks(config);
});
it('other value', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_play: 'selected',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_play: ['selected'],
},
});
postUpgradeChecks(config);
});
});
describe('auto_pause', () => {
it('all', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_pause: 'all',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {},
});
postUpgradeChecks(config);
});
it('never', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_pause: 'never',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_pause: [],
},
});
postUpgradeChecks(config);
});
it('other value', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_pause: 'unselected',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_pause: ['unselected'],
},
});
postUpgradeChecks(config);
});
});
describe('auto_mute', () => {
it('all', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_mute: 'all',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {},
});
postUpgradeChecks(config);
});
it('never', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_mute: 'never',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_mute: [],
},
});
postUpgradeChecks(config);
});
it('other value', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_mute: 'unselected',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_mute: ['unselected'],
},
});
postUpgradeChecks(config);
});
});
describe('auto_unmute', () => {
it('all', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_unmute: 'all',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_unmute: ['selected', 'visible'],
},
});
postUpgradeChecks(config);
});
it('never', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_unmute: 'never',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {},
});
postUpgradeChecks(config);
});
it('other value', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_unmute: 'selected',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
auto_unmute: ['selected'],
},
});
postUpgradeChecks(config);
});
});
});
});
describe('should rename thumbnails.media to thumbnails.events_media_type', () => {
it.each([['all' as const], ['clips' as const], ['snapshots' as const]])(
'%s',
(mediaEventType: string) => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
thumbnails: {
media: mediaEventType,
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
thumbnails: {
events_media_type: mediaEventType,
},
},
},
});
postUpgradeChecks(config);
},
);
});
describe('should rename timeline.media to timeline.events_media_type', () => {
it.each([['all' as const], ['clips' as const], ['snapshots' as const]])(
'%s',
(mediaEventType: string) => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
timeline: {
media: mediaEventType,
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
timeline: {
events_media_type: mediaEventType,
},
});
postUpgradeChecks(config);
},
);
});
describe('should rename live.controls.timeline.media to live.controls.timeline.events_media_type', () => {
it.each([['all' as const], ['clips' as const], ['snapshots' as const]])(
'%s',
(mediaEventType: string) => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
timeline: {
media: mediaEventType,
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
timeline: {
events_media_type: mediaEventType,
},
},
},
});
postUpgradeChecks(config);
},
);
});
describe('should rename media_viewer.controls.timeline.media to media_viewer.controls.timeline.events_media_type', () => {
it.each([['all' as const], ['clips' as const], ['snapshots' as const]])(
'%s',
(mediaEventType: string) => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
controls: {
timeline: {
media: mediaEventType,
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
media_viewer: {
controls: {
timeline: {
events_media_type: mediaEventType,
},
},
},
});
postUpgradeChecks(config);
},
);
});
describe('should transform scan mode', () => {
describe('should move and transform untrigger_reset', () => {
it('when true', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
view: {
scan: {
untrigger_reset: true,
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
view: {
triggers: {
actions: {
untrigger: 'default',
},
},
},
});
postUpgradeChecks(config);
});
it('when false', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
view: {
scan: {
untrigger_reset: false,
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
view: {
triggers: {},
},
});
postUpgradeChecks(config);
});
});
describe('should rename view.scan.enabled to a trigger action', () => {
it('when true', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
view: {
scan: {
enabled: true,
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
view: {
triggers: {
filter_selected_camera: false,
actions: {
trigger: 'live',
},
},
},
});
postUpgradeChecks(config);
});
it('when false', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
view: {
scan: {
enabled: false,
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
view: {
triggers: {},
},
});
postUpgradeChecks(config);
});
});
});
describe('should handle media layout changes', () => {
it('from live.layout to camera_global.dimensions', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
layout: {
fit: 'cover',
position: {
x: 42,
y: 43,
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: {},
cameras_global: {
dimensions: {
layout: {
fit: 'cover',
position: {
x: 42,
y: 43,
},
},
},
},
});
postUpgradeChecks(config);
});
describe('from delete old media layouts', () => {
it.each([['media_viewer' as const], ['image' as const]])(
'%s',
(section: string) => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
[section]: {
layout: {
fit: 'cover',
position: {
x: 42,
y: 43,
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
[section]: {},
});
postUpgradeChecks(config);
},
);
});
});
describe('from condition object to condition array', () => {
describe('with view condition', () => {
it('elements', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: {
view: ['clips', 'snapshots'],
},
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: [
{
condition: 'view' as const,
views: ['clips', 'snapshots'],
},
],
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
});
postUpgradeChecks(config);
});
it('overrides', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: {
view: ['clips', 'snapshots'],
},
overrides: {
view: {
default: 'clips',
},
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: [
{
condition: 'view' as const,
views: ['clips', 'snapshots'],
},
],
merge: {
view: {
default: 'clips',
},
},
},
],
});
postUpgradeChecks(config);
});
it('automations', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
automations: [
{
conditions: {
view: ['clips', 'snapshots'],
},
actions: [
{
action: 'custom:frigate-card-action' as const,
frigate_card_action: 'live_substream_on' as const,
},
],
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
automations: [
{
conditions: [
{
condition: 'view' as const,
views: ['clips', 'snapshots'],
},
],
actions: [
{
action: 'custom:frigate-card-action' as const,
frigate_card_action: 'live_substream_on' as const,
},
],
},
],
});
postUpgradeChecks(config);
});
});
describe('with camera condition', () => {
it('elements', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: {
camera: ['camera_1', 'camera_2'],
},
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: [
{
condition: 'camera' as const,
cameras: ['camera_1', 'camera_2'],
},
],
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
});
postUpgradeChecks(config);
});
it('overrides', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: {
camera: ['camera_1', 'camera_2'],
},
overrides: {
view: {
default: 'clips',
},
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: [
{
condition: 'camera' as const,
cameras: ['camera_1', 'camera_2'],
},
],
merge: {
view: {
default: 'clips',
},
},
},
],
});
postUpgradeChecks(config);
});
it('automations', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
automations: [
{
conditions: {
camera: ['camera_1', 'camera_2'],
},
actions: [
{
action: 'custom:frigate-card-action' as const,
frigate_card_action: 'live_substream_on' as const,
},
],
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
automations: [
{
conditions: [
{
condition: 'camera' as const,
cameras: ['camera_1', 'camera_2'],
},
],
actions: [
{
action: 'custom:frigate-card-action' as const,
frigate_card_action: 'live_substream_on' as const,
},
],
},
],
});
postUpgradeChecks(config);
});
});
describe('with boolean conditions', () => {
describe.each([
['fullscreen' as const],
['expand' as const],
['media_loaded' as const],
])('%s', (condition: string) => {
it('elements', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: {
[condition]: true,
},
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: [
{
condition: condition,
[condition]: true,
},
],
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
});
postUpgradeChecks(config);
});
it('overrides', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: {
[condition]: true,
},
overrides: {
view: {
default: 'clips',
},
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: [
{
condition: condition,
[condition]: true,
},
],
merge: {
view: {
default: 'clips',
},
},
},
],
});
postUpgradeChecks(config);
});
it('automations', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
automations: [
{
conditions: {
[condition]: true,
},
actions: [
{
action: 'custom:frigate-card-action' as const,
frigate_card_action: 'live_substream_on' as const,
},
],
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
automations: [
{
conditions: [
{
condition: condition,
[condition]: true,
},
],
actions: [
{
action: 'custom:frigate-card-action' as const,
frigate_card_action: 'live_substream_on' as const,
},
],
},
],
});
postUpgradeChecks(config);
});
});
});
describe('with state condition', () => {
it('elements', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: {
state: [
{
entity: 'binary_sensor.first',
state: 'on',
},
{
entity: 'binary_sensor.second',
state_not: 'off',
},
{},
],
},
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: [
{
condition: 'state' as const,
entity: 'binary_sensor.first',
state: 'on',
},
{
condition: 'state' as const,
entity: 'binary_sensor.second',
state_not: 'off',
},
],
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
});
postUpgradeChecks(config);
});
it('overrides', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: {
state: [
{
entity: 'binary_sensor.first',
state: 'on',
},
{
entity: 'binary_sensor.second',
state_not: 'off',
},
{},
],
},
overrides: {
view: {
default: 'clips',
},
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: [
{
condition: 'state' as const,
entity: 'binary_sensor.first',
state: 'on',
},
{
condition: 'state' as const,
entity: 'binary_sensor.second',
state_not: 'off',
},
],
merge: {
view: {
default: 'clips',
},
},
},
],
});
postUpgradeChecks(config);
});
it('automations', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
automations: [
{
conditions: {
state: [
{
entity: 'binary_sensor.first',
state: 'on',
},
{
entity: 'binary_sensor.second',
state_not: 'off',
},
{},
],
},
actions: [
{
action: 'custom:frigate-card-action' as const,
frigate_card_action: 'live_substream_on' as const,
},
],
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
automations: [
{
conditions: [
{
condition: 'state' as const,
entity: 'binary_sensor.first',
state: 'on',
},
{
condition: 'state' as const,
entity: 'binary_sensor.second',
state_not: 'off',
},
],
actions: [
{
action: 'custom:frigate-card-action' as const,
frigate_card_action: 'live_substream_on' as const,
},
],
},
],
});
postUpgradeChecks(config);
});
});
describe('with media query condition', () => {
it('elements', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: {
media_query: 'query',
},
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'custom:random',
conditions: [
{
condition: 'screen' as const,
media_query: 'query',
},
],
},
{
type: 'custom:random2',
conditions: 'not an object',
},
],
});
postUpgradeChecks(config);
});
it('overrides', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: {
media_query: 'query',
},
overrides: {
view: {
default: 'clips',
},
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
overrides: [
{
conditions: [
{
condition: 'screen' as const,
media_query: 'query',
},
],
merge: {
view: {
default: 'clips',
},
},
},
],
});
postUpgradeChecks(config);
});
it('automations', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
automations: [
{
conditions: {
media_query: 'query',
},
actions: [
{
action: 'custom:frigate-card-action' as const,
frigate_card_action: 'live_substream_on' as const,
},
],
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
automations: [
{
conditions: [
{
condition: 'screen' as const,
media_query: 'query',
},
],
actions: [
{
action: 'custom:frigate-card-action' as const,
frigate_card_action: 'live_substream_on' as const,
},
],
},
],
});
postUpgradeChecks(config);
});
});
});
describe('from hide to substream capability disable', () => {
it('overrides', () => {
const config = {
type: 'custom:frigate-card',
cameras: [
{ camera_entity: 'camera.office', hide: true },
{ camera_entity: 'camera.sitting_room', hide: false },
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [
{
camera_entity: 'camera.office',
capabilities: { disable_except: ['substream'] },
},
{ camera_entity: 'camera.sitting_room' },
],
});
postUpgradeChecks(config);
});
describe('from performance profile to generic profile', () => {
it('low performance', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
performance: {
profile: 'low',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
profiles: ['low-performance'],
performance: {},
});
postUpgradeChecks(config);
});
it('high performance', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
performance: {
profile: 'high',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
performance: {},
});
postUpgradeChecks(config);
});
});
});
it('from overrides to merge', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
overrides: [
{
conditions: [
{
condition: 'view',
views: ['clips'],
},
],
overrides: {
menu: {
style: 'hidden',
},
},
},
],
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
overrides: [
{
conditions: [
{
condition: 'view',
views: ['clips'],
},
],
merge: {
menu: {
style: 'hidden',
},
},
},
],
});
postUpgradeChecks(config);
});
describe('split live.ptz', () => {
const getActionBefore = (action: PTZControlAction): CallServiceActionConfig => ({
action: 'call-service',
service: 'service',
data: {
arg: action,
},
});
const getActionAfter = (action: PTZControlAction): PerformActionActionConfig => ({
action: 'perform-action',
perform_action: 'service',
data: {
arg: action,
},
});
const getTapAction = (action: PTZControlAction): Actions => ({
tap_action: getActionBefore(action),
});
it('with action_ format', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
ptz: {
actions_up: getTapAction('up'),
actions_down: getTapAction('down'),
actions_left: getTapAction('left'),
actions_right: getTapAction('right'),
actions_zoom_in: getTapAction('zoom_in'),
actions_zoom_out: getTapAction('zoom_out'),
actions_home: {
...getTapAction('home'),
double_tap_action: getActionBefore('up'),
},
mode: 'auto' as const,
position: 'bottom-right' as const,
orientation: 'horizontal' as const,
hide_pan_tilt: false,
hide_zoom: false,
hide_home: false,
style: {
color: 'red',
},
something_not_related: 'very_unrelated',
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
cameras_global: {
ptz: {
actions_left: getActionAfter('left'),
actions_right: getActionAfter('right'),
actions_up: getActionAfter('up'),
actions_down: getActionAfter('down'),
actions_zoom_in: getActionAfter('zoom_in'),
actions_zoom_out: getActionAfter('zoom_out'),
presets: {
home: getActionAfter('home'),
},
},
},
live: {
controls: {
ptz: {
mode: 'auto' as const,
position: 'bottom-right' as const,
orientation: 'horizontal' as const,
hide_pan_tilt: false,
hide_zoom: false,
hide_home: false,
style: {
color: 'red',
},
},
},
},
});
postUpgradeChecks(config);
});
it('with data_ format', () => {
const getDataAction = (action: PTZControlAction): Actions => ({
action: {
device: '048123',
cmd: action,
},
});
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
ptz: {
service: 'service',
data_up: getDataAction('up'),
data_down: getDataAction('down'),
data_left: getDataAction('left'),
data_right: getDataAction('right'),
data_zoom_in: getDataAction('zoom_in'),
data_zoom_out: getDataAction('zoom_out'),
data_home: getDataAction('home'),
mode: 'auto' as const,
position: 'bottom-right' as const,
orientation: 'horizontal' as const,
hide_pan_tilt: false,
hide_zoom: false,
hide_home: false,
style: {
color: 'red',
},
something_not_related: 'very_unrelated',
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
cameras_global: {
ptz: {
service: 'service',
data_left: getDataAction('left'),
data_right: getDataAction('right'),
data_up: getDataAction('up'),
data_down: getDataAction('down'),
data_zoom_in: getDataAction('zoom_in'),
data_zoom_out: getDataAction('zoom_out'),
presets: {
service: 'service',
data_home: getDataAction('home'),
},
},
},
live: {
controls: {
ptz: {
mode: 'auto' as const,
position: 'bottom-right' as const,
orientation: 'horizontal' as const,
hide_pan_tilt: false,
hide_zoom: false,
hide_home: false,
style: {
color: 'red',
},
},
},
},
});
postUpgradeChecks(config);
});
it('with invalid ptz type', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
ptz: 3, // Not an object.
},
},
};
expect(upgradeConfig(config)).toBeFalsy();
});
it('with nothing to transform', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
ptz: {
mode: 'auto',
},
},
},
};
expect(upgradeConfig(config)).toBeFalsy();
});
it('without tap_action', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
ptz: {
actions_up: {
double_tap_action: getActionBefore('up'),
},
actions_down: getTapAction('down'),
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual(
expect.objectContaining({
cameras_global: {
ptz: {
actions_down: getActionAfter('down'),
},
},
}),
);
postUpgradeChecks(config);
});
it('without pre-existing presets', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
ptz: {
presets: {
home: getActionBefore('left'),
other: getActionBefore('right'),
},
actions_home: getTapAction('home'),
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual(
expect.objectContaining({
cameras_global: {
ptz: {
presets: {
other: getActionAfter('right'),
home: getActionAfter('home'),
},
},
},
}),
);
postUpgradeChecks(config);
});
});
it('view.update_cycle_camera -> view.default_cycle_camera', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
view: {
update_cycle_camera: true,
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config.view).toEqual({
default_cycle_camera: true,
});
postUpgradeChecks(config);
});
describe('view.update_force -> view.default_reset.interaction_mode', () => {
it('should convert to all when true', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
view: {
update_force: true,
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config.view).toEqual({
default_reset: {
interaction_mode: 'all',
},
});
postUpgradeChecks(config);
});
it('should remove when false', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
view: {
update_force: false,
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config.view).toEqual({});
postUpgradeChecks(config);
});
});
it('view.update_seconds', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
view: {
update_seconds: 42,
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config.view).toEqual({
default_reset: {
every_seconds: 42,
},
});
postUpgradeChecks(config);
});
it('view.update_entities', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
view: {
update_entities: ['binary_sensor.foo', 'camera.bar'],
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config.view).toEqual({
default_reset: {
entities: ['binary_sensor.foo', 'camera.bar'],
},
});
postUpgradeChecks(config);
});
describe('title controls to status bar', () => {
it('when mode is none', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
title: {
mode: 'none',
},
},
},
media_viewer: {
controls: {
title: {
mode: 'none',
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: { controls: {} },
media_viewer: { controls: {} },
status_bar: {
style: 'none',
},
});
postUpgradeChecks(config);
});
describe('when mode is invalid type', () => {
it.each([[{ mode: { should_not_be: 'an object' } }], ['sideways']])(
'%s',
(mode: unknown) => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
title: {
mode,
},
},
},
media_viewer: {
controls: {
title: {
mode,
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: { controls: {} },
media_viewer: { controls: {} },
});
postUpgradeChecks(config);
},
);
});
describe.each([['bottom'], ['top']])('on the %s', (position: string) => {
it.each([
[`popup-${position}-left` as const],
[`popup-${position}-right` as const],
])('%s', (mode: string) => {
const config = {
type: 'custom:frigate-card',
cameras: [{}],
live: {
controls: {
title: {
mode,
},
},
},
media_viewer: {
controls: {
title: {
mode,
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{}],
live: { controls: {} },
media_viewer: { controls: {} },
status_bar: {
position,
},
});
postUpgradeChecks(config);
});
});
});
it('rename call-service -> perform-action', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'icon',
icon: 'mdi:cow',
tap_action: {
action: 'call-service',
service: 'foo',
},
},
],
view: {
actions: {
double_tap_action: {
action: 'call-service',
service: 'bar',
data: {
key: 'value',
},
},
},
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
elements: [
{
type: 'icon',
icon: 'mdi:cow',
tap_action: {
action: 'perform-action',
perform_action: 'foo',
},
},
],
view: {
actions: {
double_tap_action: {
action: 'perform-action',
perform_action: 'bar',
data: {
key: 'value',
},
},
},
},
});
postUpgradeChecks(config);
});
it('rename dimensions.max_height -> dimensions.height', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
dimensions: {
max_height: '500px',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
dimensions: {
height: '500px',
},
});
postUpgradeChecks(config);
});
it('delete dimensions.min_height', () => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
dimensions: {
min_height: '100px',
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
dimensions: {},
});
postUpgradeChecks(config);
});
});
describe('v6.1.2+', () => {
describe('view.dark_mode -> view.dim', () => {
it.each([
['on' as const, true],
['auto' as const, false],
['off' as const, false],
])('%s', (darkMode: 'on' | 'off' | 'auto', expected: boolean) => {
const config = {
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
view: {
dark_mode: darkMode,
},
};
expect(upgradeConfig(config)).toBeTruthy();
expect(config).toEqual({
type: 'custom:frigate-card',
cameras: [{ camera_entity: 'camera.office' }],
view: {
dim: expected,
},
});
postUpgradeChecks(config);
});
});
});
});