Files
frigate/web/src/components/config-form/sectionExtras/ProxyRoleMap.tsx
T
Josh HawkinsandGitHub e7250f24cb Full UI configuration (#22151)
* use react-jsonschema-form for UI config

* don't use properties wrapper when generating config i18n json

* configure for full i18n support

* section fields

* add descriptions to all fields for i18n

* motion i18n

* fix nullable fields

* sanitize internal fields

* add switches widgets and use friendly names

* fix nullable schema entries

* ensure update_topic is added to api calls

this needs further backend implementation to work correctly

* add global sections, camera config overrides, and reset button

* i18n

* add reset logic to global config view

* tweaks

* fix sections and live validation

* fix validation for schema objects that can be null

* generic and custom per-field validation

* improve generic error validation messages

* remove show advanced fields switch

* tweaks

* use shadcn theme

* fix array field template

* i18n tweaks

* remove collapsible around root section

* deep merge schema for advanced fields

* add array field item template and fix ffmpeg section

* add missing i18n keys

* tweaks

* comment out api call for testing

* add config groups as a separate i18n namespace

* add descriptions to all pydantic fields

* make titles more concise

* new titles as i18n

* update i18n config generation script to use json schema

* tweaks

* tweaks

* rebase

* clean up

* form tweaks

* add wildcards and fix object filter fields

* add field template for additionalproperties schema objects

* improve typing

* add section description from schema and clarify global vs camera level descriptions

* separate and consolidate global and camera i18n namespaces

* clean up now obsolete namespaces

* tweaks

* refactor sections and overrides

* add ability to render components before and after fields

* fix titles

* chore(sections): remove legacy single-section components replaced by template

* refactor configs to use individual files with a template

* fix review description

* apply hidden fields after ui schema

* move util

* remove unused i18n

* clean up error messages

* fix fast refresh

* add custom validation and use it for ffmpeg input roles

* update nav tree

* remove unused

* re-add override and modified indicators

* mark pending changes and add confirmation dialog for resets

* fix red unsaved dot

* tweaks

* add docs links, readonly keys, and restart required per field

* add special case and comments for global motion section

* add section form special cases

* combine review sections

* tweaks

* add audio labels endpoint

* add audio label switches and input to filter list

* fix type

* remove key from config when resetting to default/global

* don't show description for new key/val fields

* tweaks

* spacing tweaks

* add activity indicator and scrollbar tweaks

* add docs to filter fields

* wording changes

* fix global ffmpeg section

* add review classification zones to review form

* add backend endpoint and frontend widget for ffmpeg presets and manual args

* improve wording

* hide descriptions for additional properties arrays

* add warning log about incorrectly nested model config

* spacing and language tweaks

* fix i18n keys

* networking section docs and description

* small wording tweaks

* add layout grid field

* refactor with shared utilities

* field order

* add individual detectors to schema

add detector titles and descriptions (docstrings in pydantic are used for descriptions) and add i18n keys to globals

* clean up detectors section and i18n

* don't save model config back to yaml when saving detectors

* add full detectors config to api model dump

works around the way we use detector plugins so we can have the full detector config for the frontend

* add restart button to toast when restart is required

* add ui option to remove inner cards

* fix buttons

* section tweaks

* don't zoom into text on mobile

* make buttons sticky at bottom of sections

* small tweaks

* highlight label of changed fields

* add null to enum list when unwrapping

* refactor to shared utils and add save all button

* add undo all button

* add RJSF to dictionary

* consolidate utils

* preserve form data when changing cameras

* add mono fonts

* add popover to show what fields will be saved

* fix mobile menu not re-rendering with unsaved dots

* tweaks

* fix logger and env vars config section saving

use escaped periods in keys to retain them in the config file (eg "frigate.embeddings")

* add timezone widget

* role map field with validation

* fix validation for model section

* add another hidden field

* add footer message for required restart

* use rjsf for notifications view

* fix config saving

* add replace rules field

* default column layout and add field sizing

* clean up field template

* refactor profile settings to match rjsf forms

* tweaks

* refactor frigate+ view and make tweaks to sections

* show frigate+ model info in detection model settings when using a frigate+ model

* update restartRequired for all fields

* fix restart fields

* tweaks and add ability enable disabled cameras

more backend changes required

* require restart when enabling camera that is disabled in config

* disable save when form is invalid

* refactor ffmpeg section for readability

* change label

* clean up camera inputs fields

* misc tweaks to ffmpeg section

- add raw paths endpoint to ensure credentials get saved
- restart required tooltip

* maintenance settings tweaks

* don't mutate with lodash

* fix description re-rendering for nullable object fields

* hide reindex field

* update rjsf

* add frigate+ description to settings pane

* disable save all when any section is invalid

* show translated field name in validation error pane

* clean up

* remove unused

* fix genai merge

* fix genai
2026-02-27 08:55:36 -07:00

202 lines
6.3 KiB
TypeScript

import { useMemo } from "react";
import type { ComponentType } from "react";
import { useTranslation } from "react-i18next";
import cloneDeep from "lodash/cloneDeep";
import get from "lodash/get";
import set from "lodash/set";
import { Button } from "@/components/ui/button";
import { Label } from "@/components/ui/label";
import {
Select,
SelectContent,
SelectItem,
SelectTrigger,
SelectValue,
} from "@/components/ui/select";
import { LuPlus, LuTrash2 } from "react-icons/lu";
import { TagsWidget } from "@/components/config-form/theme/widgets/TagsWidget";
import { isJsonObject } from "@/lib/utils";
import type { ConfigSectionData, JsonObject } from "@/types/configForm";
import type { SectionRendererProps } from "./registry";
const EMPTY_FORM_DATA: JsonObject = {};
const RoleMapTags = TagsWidget as unknown as ComponentType<{
id: string;
value: string[];
onChange: (value: unknown) => void;
schema: { title: string };
}>;
export default function ProxyRoleMap({ formContext }: SectionRendererProps) {
const { t } = useTranslation(["views/settings", "config/global"]);
const fullFormData =
(formContext?.formData as JsonObject | undefined) ?? EMPTY_FORM_DATA;
const onFormDataChange = formContext?.onFormDataChange;
const roleHeader = get(fullFormData, "header_map.role");
const hasRoleHeader =
typeof roleHeader === "string" && roleHeader.trim().length > 0;
const roleMap = useMemo(() => {
const roleMapValue = get(fullFormData, "header_map.role_map");
return isJsonObject(roleMapValue)
? (roleMapValue as Record<string, string[]>)
: {};
}, [fullFormData]);
const roleOptions = useMemo(() => {
const rolesFromConfig = formContext?.fullConfig?.auth?.roles
? Object.keys(formContext.fullConfig.auth.roles)
: [];
const roles =
rolesFromConfig.length > 0 ? rolesFromConfig : ["admin", "viewer"];
return Array.from(new Set([...roles, ...Object.keys(roleMap)])).sort();
}, [formContext?.fullConfig, roleMap]);
if (!onFormDataChange || !formContext?.formData) {
return null;
}
if (!hasRoleHeader) {
return null;
}
const usedRoles = new Set(Object.keys(roleMap));
const nextRole = roleOptions.find((role) => !usedRoles.has(role));
const updateRoleMap = (nextRoleMap: Record<string, string[]>) => {
const nextFormData = cloneDeep(fullFormData) as JsonObject;
set(nextFormData, "header_map.role_map", nextRoleMap);
onFormDataChange(nextFormData as ConfigSectionData);
};
const handleAdd = () => {
if (!nextRole) return;
updateRoleMap({
...roleMap,
[nextRole]: [],
});
};
const handleRemove = (role: string) => {
const next = { ...roleMap };
delete next[role];
updateRoleMap(next);
};
const handleRoleChange = (currentRole: string, newRole: string) => {
if (currentRole === newRole) return;
const next = { ...roleMap } as Record<string, string[]>;
const groups = next[currentRole] ?? [];
delete next[currentRole];
next[newRole] = groups;
updateRoleMap(next);
};
const handleGroupsChange = (role: string, groups: unknown) => {
updateRoleMap({
...roleMap,
[role]: Array.isArray(groups) ? groups : [],
});
};
const roleMapLabel = t("proxy.header_map.role_map.label", {
ns: "config/global",
});
const roleMapDescription = t("proxy.header_map.role_map.description", {
ns: "config/global",
});
return (
<div className="space-y-4">
<div className="space-y-1">
<Label className="text-sm font-medium">{roleMapLabel}</Label>
<p className="text-xs text-muted-foreground">{roleMapDescription}</p>
</div>
{Object.keys(roleMap).length === 0 && (
<p className="text-sm italic text-muted-foreground">
{t("configForm.roleMap.empty", { ns: "views/settings" })}
</p>
)}
{Object.entries(roleMap).map(([role, groups], index) => {
const rowId = `role-map-${role}-${index}`;
const roleLabel = t("configForm.roleMap.roleLabel", {
ns: "views/settings",
});
const groupsLabel = t("configForm.roleMap.groupsLabel", {
ns: "views/settings",
});
const normalizedGroups = Array.isArray(groups) ? groups : [];
return (
<div key={rowId} className="grid grid-cols-12 items-start gap-2">
<div className="col-span-12 space-y-2 md:col-span-4">
<Label htmlFor={`${rowId}-role`}>{roleLabel}</Label>
<Select
value={role}
onValueChange={(next) => handleRoleChange(role, next)}
>
<SelectTrigger id={`${rowId}-role`} className="w-full">
<SelectValue placeholder={roleLabel} />
</SelectTrigger>
<SelectContent>
{roleOptions.map((option) => (
<SelectItem key={option} value={option}>
{option}
</SelectItem>
))}
</SelectContent>
</Select>
</div>
<div className="col-span-12 space-y-2 md:col-span-7">
<Label htmlFor={`${rowId}-groups`}>{groupsLabel}</Label>
<RoleMapTags
id={`${rowId}-groups`}
value={normalizedGroups}
onChange={(next) => handleGroupsChange(role, next)}
schema={{ title: groupsLabel }}
/>
</div>
<div className="col-span-12 flex items-center md:col-span-1 md:justify-center md:pt-7">
<Button
type="button"
variant="ghost"
size="icon"
onClick={() => handleRemove(role)}
aria-label={t("configForm.roleMap.remove", {
ns: "views/settings",
})}
title={t("configForm.roleMap.remove", {
ns: "views/settings",
})}
>
<LuTrash2 className="h-4 w-4" />
</Button>
</div>
</div>
);
})}
<Button
type="button"
variant="outline"
size="sm"
onClick={handleAdd}
disabled={!nextRole}
className="gap-2"
>
<LuPlus className="h-4 w-4" />
{t("configForm.roleMap.addMapping", {
ns: "views/settings",
})}
</Button>
</div>
);
}