flan/advanced-camera-card
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Rename the card to advanced-camera-card (#1873)

Browse Source 
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.
This commit is contained in:
Dermot Duffy
2025-02-06 19:32:32 -08:00
committed by GitHub
parent 43947b49dc
commit cc376a8be1
305 changed files with 4270 additions and 3686 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/card-controller/config/config-manager.test.ts
+19 -23
View File
@@ -3,7 +3,7 @@ import { ZodError } from 'zod';
import { getOverriddenConfig } from '../../../src/card-controller/conditions-manager';
import { ConfigManager } from '../../../src/card-controller/config/config-manager';
import { InitializationAspect } from '../../../src/card-controller/initialization-manager';
import { frigateCardConfigSchema } from '../../../src/config/types';
import { advancedCameraCardConfigSchema } from '../../../src/config/types';
import { createCardAPI, createConfig, flushPromises } from '../../test-utils';
vi.mock('../../../src/card-controller/conditions-manager.js');
@@ -20,7 +20,7 @@ describe('ConfigManager', () => {
});
it('invalid configuration', () => {
const spy = vi.spyOn(frigateCardConfigSchema, 'safeParse').mockReturnValue({
const spy = vi.spyOn(advancedCameraCardConfigSchema, 'safeParse').mockReturnValue({
success: false,
error: new ZodError([]),
});
@@ -44,18 +44,14 @@ describe('ConfigManager', () => {
const manager = new ConfigManager(createCardAPI());
expect(() =>
manager.setConfig({
cameras: [
{
frigate: {
label: 'foo',
},
},
],
// This key needs to be upgradeable in `management.ts` .
type: 'custom:frigate-card',
cameras: 'WILL_NOT_PARSE',
}),
).toThrowError(
'An automated card configuration upgrade is ' +
'available, please visit the visual card editor. ' +
'Invalid configuration: [\n "type"\n]',
'Invalid configuration: [\n "cameras"\n]',
);
});
});
@@ -72,7 +68,7 @@ describe('ConfigManager', () => {
const api = createCardAPI();
const manager = new ConfigManager(api);
const config = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
};
@@ -105,7 +101,7 @@ describe('ConfigManager', () => {
it('should apply profiles', () => {
const manager = new ConfigManager(createCardAPI());
const config = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
profiles: ['low-performance'],
};
@@ -120,7 +116,7 @@ describe('ConfigManager', () => {
const api = createCardAPI();
const manager = new ConfigManager(api);
const config = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
};
@@ -137,7 +133,7 @@ describe('ConfigManager', () => {
const api = createCardAPI();
const manager = new ConfigManager(api);
const config = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
debug: {
logging: true,
@@ -183,7 +179,7 @@ describe('ConfigManager', () => {
const api = createCardAPI();
const manager = new ConfigManager(api);
const config = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
};
vi.mocked(getOverriddenConfig).mockReturnValue(config);
@@ -201,14 +197,14 @@ describe('ConfigManager', () => {
const api = createCardAPI();
const manager = new ConfigManager(api);
const config_1 = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
};
manager.setConfig(config_1);
vi.mocked(api.getStyleManager().updateFromConfig).mockClear();
const config_2 = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.kitchen' }],
};
vi.mocked(getOverriddenConfig).mockReturnValue(config_2);
@@ -223,7 +219,7 @@ describe('ConfigManager', () => {
const api = createCardAPI();
const manager = new ConfigManager(api);
manager.setConfig({
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
});
@@ -242,7 +238,7 @@ describe('ConfigManager', () => {
const api = createCardAPI();
const manager = new ConfigManager(api);
const config_1 = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
};
vi.mocked(getOverriddenConfig).mockReturnValue(createConfig(config_1));
@@ -253,7 +249,7 @@ describe('ConfigManager', () => {
);
const config_2 = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.kitchen' }],
};
vi.mocked(getOverriddenConfig).mockReturnValue(createConfig(config_2));
@@ -268,7 +264,7 @@ describe('ConfigManager', () => {
const api = createCardAPI();
const manager = new ConfigManager(api);
const config_1 = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
};
vi.mocked(getOverriddenConfig).mockReturnValue(createConfig(config_1));
@@ -296,7 +292,7 @@ describe('ConfigManager', () => {
const api = createCardAPI();
const manager = new ConfigManager(api);
const config_1 = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
live: {
microphone: {
@@ -332,7 +328,7 @@ describe('ConfigManager', () => {
const api = createCardAPI();
const manager = new ConfigManager(api);
const config = {
type: 'custom:frigate-card',
type: 'custom:advanced-camera-card',
cameras: [{ camera_entity: 'camera.office' }],
};
vi.mocked(getOverriddenConfig).mockReturnValue(createConfig(config));
tests/card-controller/config/load-automations.test.ts
+1 -1
View File
@@ -17,7 +17,7 @@ describe('setAutomationsFromConfig', () => {
actions: [
{
action: 'fire-dom-event' as const,
frigate_card_action: 'clips',
advanced_camera_card_action: 'clips',
},
],
conditions: [{ condition: 'fullscreen' as const, fullscreen: true }],
tests/card-controller/config/load-keyboard-shortcuts.test.ts
+3 -3
View File
@@ -67,7 +67,7 @@ describe('setKeyboardShortcutsFromConfig', () => {
actions: [
{
action: 'fire-dom-event',
frigate_card_action: 'ptz_multi',
advanced_camera_card_action: 'ptz_multi',
ptz_action: ptzAction,
ptz_phase: 'start',
},
@@ -89,7 +89,7 @@ describe('setKeyboardShortcutsFromConfig', () => {
actions: [
{
action: 'fire-dom-event',
frigate_card_action: 'ptz_multi',
advanced_camera_card_action: 'ptz_multi',
ptz_action: ptzAction,
ptz_phase: 'stop',
},
@@ -119,7 +119,7 @@ describe('setKeyboardShortcutsFromConfig', () => {
actions: [
{
action: 'fire-dom-event',
frigate_card_action: 'ptz_multi',
advanced_camera_card_action: 'ptz_multi',
},
],
conditions: [