feat(custom-widgets): add secure v2 authoring

This commit is contained in:
Thomas Camlong committed 2026-07-12 14:35:35 +02:00
1 parent d37545c98e
commit 46add018bf
56 files changed
+12613 -1726

No files matched your search

+390 -76
View File
@@ -1,5 +1,5 @@
import type { ComponentType, ReactNode } from "react";
import { createElement, useState } from "react";
import { createElement, useEffect, useRef, useState } from "react";
import {
Accordion,
ActionIcon,
@@ -22,12 +22,12 @@ import {
Collapse,
ColorSwatch,
Container,
CopyButton,
DataList,
Divider,
EmptyState,
Fieldset,
Flex,
FloatingIndicator,
Grid,
Group,
Highlight,
@@ -37,6 +37,7 @@ import {
Kbd,
List,
Loader,
LoadingOverlay,
Mark,
Marquee,
Menu,
@@ -71,12 +72,16 @@ import {
Tooltip,
Transition,
Tree,
Typography,
VisuallyHidden,
} from "@mantine/core";
import {
AreaChart,
BarChart,
BarsList,
BubbleChart,
ChartLegend,
ChartTooltip,
CompositeChart,
DonutChart,
FunnelChart,
@@ -90,10 +95,139 @@ import {
Sparkline,
Treemap,
} from "@mantine/charts";
import { Calendar, DatePicker, MiniCalendar, TimeValue } from "@mantine/dates";
import {
IconActivity,
IconAlertCircle,
IconAlertTriangle,
IconApi,
IconArrowDown,
IconArrowLeft,
IconArrowRight,
IconArrowUp,
IconBell,
IconBluetooth,
IconBolt,
IconBookmark,
IconBug,
IconCalendar,
IconCamera,
IconChartBar,
IconChartLine,
IconChartPie,
IconCheck,
IconChevronDown,
IconChevronLeft,
IconChevronRight,
IconChevronUp,
IconCircleCheck,
IconCircleX,
IconClipboard,
IconClock,
IconCloud,
IconCloudOff,
IconCode,
IconCompass,
IconCopy,
IconCpu,
IconDatabase,
IconDeviceDesktop,
IconDeviceMobile,
IconDownload,
IconDroplet,
IconEdit,
IconExternalLink,
IconEye,
IconEyeOff,
IconFile,
IconFlag,
IconFlame,
IconFolder,
IconGauge,
IconGitBranch,
IconHeart,
IconHistory,
IconHome,
IconInfoCircle,
IconKey,
IconLink,
IconLoader,
IconLock,
IconLockOpen,
IconMail,
IconMap,
IconMapPin,
IconMinus,
IconMoon,
IconMusic,
IconNetwork,
IconPhoto,
IconPin,
IconPlayerPause,
IconPlayerPlay,
IconPlayerSkipBack,
IconPlayerSkipForward,
IconPlayerStop,
IconPlus,
IconPower,
IconProgress,
IconHeartbeat,
IconRefresh,
IconReload,
IconSearch,
IconServer,
IconSettings,
IconShield,
IconStar,
IconSun,
IconTerminal,
IconThermometer,
IconTrash,
IconTrendingDown,
IconTrendingUp,
IconUpload,
IconUser,
IconUsers,
IconVideo,
IconVolume,
IconVolume2,
IconVolumeOff,
IconWifi,
IconWifiOff,
IconWorld,
IconX,
IconSpeedboat,
} from "@tabler/icons-react";
import {
Calendar,
CalendarHeader,
DatePicker,
Day,
DecadeLevel,
DecadeLevelGroup,
LevelsGroup,
MiniCalendar,
Month,
MonthLevel,
MonthLevelGroup,
MonthPicker,
MonthsList,
PickerControl,
TimeGrid,
TimeValue,
WeekdaysRow,
YearLevel,
YearLevelGroup,
YearPicker,
YearsList,
} from "@mantine/dates";
import { enabledCustomJsxComponents } from "@homarr/definitions";
import { useScopedI18n } from "@homarr/translation/client";
import { PaginatedList, TabsContainer, TabPanel, Collapsible, StatBar, TypeBadge } from "./jsx-interactive-components";
import { SubFetch, SubData, ActionButton, ToggleSwitch, RefreshButton } from "./jsx-sub-fetch";
import { createSafeCallable } from "./safe-bindings";
import { sanitizeCustomJsxProps } from "./safe-jsx-interpreter";
const SAFE_URL_PATTERN = /^https?:\/\//i;
@@ -102,110 +236,257 @@ function isSafeUrl(url: unknown): boolean {
return SAFE_URL_PATTERN.test(url) || url.startsWith("/") || url.startsWith("#");
}
function stripEventHandlers(props: Record<string, unknown>): Record<string, unknown> {
const safe: Record<string, unknown> = {};
for (const [key, value] of Object.entries(props)) {
if (/^on[A-Z]/.test(key)) continue;
safe[key] = value;
}
return safe;
}
function SafeAnchor(props: Record<string, unknown>) {
const href = props.href;
const safeHref = href && isSafeUrl(href) ? href : undefined;
return createElement(Anchor as never, { ...stripEventHandlers(props), href: safeHref });
return createElement(Anchor as never, { ...sanitizeCustomJsxProps(props), href: safeHref });
}
function SafeNavLink(props: Record<string, unknown>) {
const href = props.href;
const safeHref = href && isSafeUrl(href) ? href : undefined;
return createElement(NavLink as never, { ...stripEventHandlers(props), href: safeHref });
return createElement(NavLink as never, { ...sanitizeCustomJsxProps(props), href: safeHref });
}
function SafeButton(props: Record<string, unknown>) {
return createElement(Button as never, stripEventHandlers(props));
return createElement(Button as never, sanitizeCustomJsxProps(props));
}
function SafeActionIcon(props: Record<string, unknown>) {
return createElement(ActionIcon as never, stripEventHandlers(props));
return createElement(ActionIcon as never, sanitizeCustomJsxProps(props));
}
function SafeBurger(props: Record<string, unknown>) {
return createElement(Burger as never, stripEventHandlers(props));
return createElement(Burger as never, sanitizeCustomJsxProps(props));
}
function SafeCloseButton(props: Record<string, unknown>) {
return createElement(CloseButton as never, stripEventHandlers(props));
return createElement(CloseButton as never, sanitizeCustomJsxProps(props));
}
function SafeChip(props: Record<string, unknown>) {
return createElement(Chip as never, stripEventHandlers(props));
return createElement(Chip as never, sanitizeCustomJsxProps(props));
}
function SafeNotification(props: Record<string, unknown>) {
return createElement(Notification as never, stripEventHandlers(props));
return createElement(Notification as never, sanitizeCustomJsxProps(props));
}
function SafeRating(props: Record<string, unknown>) {
return createElement(Rating as never, { ...stripEventHandlers(props), readOnly: true });
return createElement(Rating as never, { ...sanitizeCustomJsxProps(props), readOnly: true });
}
function SafeSlider(props: Record<string, unknown>) {
return createElement(Slider as never, { ...stripEventHandlers(props), readOnly: true });
return createElement(Slider as never, { ...sanitizeCustomJsxProps(props), readOnly: true });
}
function SafeSwitch(props: Record<string, unknown>) {
return createElement(Switch as never, { ...stripEventHandlers(props), readOnly: true });
return createElement(Switch as never, { ...sanitizeCustomJsxProps(props), readOnly: true });
}
function SafeSegmentedControl(props: Record<string, unknown>) {
return createElement(SegmentedControl as never, stripEventHandlers(props));
return createElement(SegmentedControl as never, { ...sanitizeCustomJsxProps(props), readOnly: true });
}
function SafePagination(props: Record<string, unknown>) {
return createElement(Pagination as never, stripEventHandlers(props));
return createElement(Pagination as never, { ...sanitizeCustomJsxProps(props), disabled: true });
}
function SafeStepper(props: Record<string, unknown>) {
return createElement(Stepper as never, stripEventHandlers(props));
return createElement(Stepper as never, sanitizeCustomJsxProps(props));
}
function SafeCalendar(props: Record<string, unknown>) {
return createElement(Calendar as never, { ...stripEventHandlers(props), static: true });
return createElement(Calendar as never, { ...sanitizeCustomJsxProps(props), static: true });
}
function SafeMiniCalendar(props: Record<string, unknown>) {
return createElement(MiniCalendar as never, { ...stripEventHandlers(props), static: true });
return createElement(MiniCalendar as never, { ...sanitizeCustomJsxProps(props), static: true });
}
function SafeTree(props: Record<string, unknown>) {
return createElement(Tree as never, stripEventHandlers(props));
return createElement(Tree as never, sanitizeCustomJsxProps(props));
}
function SafeDatePicker(props: Record<string, unknown>) {
return createElement(DatePicker as never, { ...stripEventHandlers(props), static: true });
return createElement(DatePicker as never, { ...sanitizeCustomJsxProps(props), static: true });
}
function createSafeDateComponent(component: ComponentType<never>) {
return function SafeDateComponent(props: Record<string, unknown>) {
return createElement(component, { ...sanitizeCustomJsxProps(props), static: true } as never);
};
}
function tablerIconExportToKey(exportName: string): string {
return exportName
.slice(4)
.replace(/([a-z0-9])([A-Z])/g, "$1-$2")
.replace(/([A-Z]+)([A-Z][a-z])/g, "$1-$2")
.replace(/([A-Za-z])(\d)/g, "$1-$2")
.toLowerCase();
}
const TABLER_ICON_IMPORTS = {
IconCheck,
IconX,
IconPlus,
IconMinus,
IconArrowUp,
IconArrowDown,
IconArrowLeft,
IconArrowRight,
IconChevronUp,
IconChevronDown,
IconChevronLeft,
IconChevronRight,
IconHome,
IconSettings,
IconUser,
IconUsers,
IconSearch,
IconBell,
IconMail,
IconHeart,
IconStar,
IconBookmark,
IconFlag,
IconPin,
IconPlayerPlay,
IconPlayerPause,
IconPlayerStop,
IconPlayerSkipForward,
IconPlayerSkipBack,
IconVolume,
IconVolumeOff,
IconVolume2,
IconWifi,
IconWifiOff,
IconBluetooth,
IconCloud,
IconCloudOff,
IconServer,
IconDatabase,
IconCpu,
IconDeviceDesktop,
IconDeviceMobile,
IconFolder,
IconFile,
IconDownload,
IconUpload,
IconRefresh,
IconReload,
IconPower,
IconBolt,
IconFlame,
IconDroplet,
IconSun,
IconMoon,
IconEye,
IconEyeOff,
IconLock,
IconLockOpen,
IconShield,
IconKey,
IconAlertTriangle,
IconAlertCircle,
IconInfoCircle,
IconCircleCheck,
IconCircleX,
IconTrash,
IconEdit,
IconCopy,
IconClipboard,
IconExternalLink,
IconLink,
IconPhoto,
IconCamera,
IconMusic,
IconVideo,
IconCalendar,
IconClock,
IconHistory,
IconMap,
IconMapPin,
IconCompass,
IconTerminal,
IconCode,
IconBug,
IconGitBranch,
IconNetwork,
IconWorld,
IconApi,
IconChartBar,
IconChartLine,
IconChartPie,
IconTrendingUp,
IconTrendingDown,
IconActivity,
IconProgress,
IconLoader,
IconThermometer,
IconGauge,
IconSpeedboat,
IconHeartbeat,
} as const;
const TABLER_ICON_MAP: Record<string, ComponentType<never>> = {
...Object.fromEntries(
Object.entries(TABLER_ICON_IMPORTS).map(([exportName, IconComponent]) => [
tablerIconExportToKey(exportName),
IconComponent,
]),
),
pulse: IconHeartbeat,
};
function isValidIconProp(value: unknown): value is string | number {
return typeof value === "number" || typeof value === "string";
}
function SafeTablerIcon(props: Record<string, unknown>) {
const name = props.name;
if (typeof name !== "string") return null;
const IconComponent = TABLER_ICON_MAP[name];
if (!IconComponent) return null;
const iconProps: Record<string, unknown> = {};
if (isValidIconProp(props.size)) iconProps.size = props.size;
if (typeof props.color === "string") iconProps.color = props.color;
if (isValidIconProp(props.stroke)) iconProps.stroke = props.stroke;
return createElement(IconComponent as never, iconProps);
}
function SafeCopyButton({ value }: { value?: string; children?: ReactNode }) {
const t = useScopedI18n("widget.customApi.customJsx");
const [copied, setCopied] = useState(false);
const handleCopy = () => {
const resetTimer = useRef<ReturnType<typeof setTimeout>>(undefined);
useEffect(() => () => clearTimeout(resetTimer.current), []);
const handleCopy = async () => {
if (!value) return;
void navigator.clipboard.writeText(value).then(() => {
try {
await navigator.clipboard.writeText(value);
setCopied(true);
setTimeout(() => setCopied(false), 2000);
});
clearTimeout(resetTimer.current);
resetTimer.current = setTimeout(() => setCopied(false), 2000);
} catch {
setCopied(false);
}
};
return createElement(Button as never, {
size: "xs",
variant: copied ? "filled" : "light",
color: copied ? "teal" : "blue",
onClick: handleCopy,
children: copied ? "Copied!" : "Copy",
});
const COPY_STATES = {
idle: { variant: "light", color: "blue", label: t("copy") },
copied: { variant: "filled", color: "teal", label: t("copied") },
} as const;
const state = COPY_STATES[copied ? "copied" : "idle"];
return createElement(
Button as never,
{ size: "xs", variant: state.variant, color: state.color, onClick: () => void handleCopy() },
state.label,
);
}
export const WHITELISTED_COMPONENTS: Record<string, ComponentType<never>> = {
const RUNTIME_COMPONENTS: Record<string, ComponentType<never>> = {
// Layout
Box,
Stack,
@@ -220,6 +501,9 @@ export const WHITELISTED_COMPONENTS: Record<string, ComponentType<never>> = {
AspectRatio,
Overlay,
ScrollArea,
VisuallyHidden,
Typography,
FloatingIndicator,
// Typography & text
Text,
@@ -284,6 +568,7 @@ export const WHITELISTED_COMPONENTS: Record<string, ComponentType<never>> = {
"EmptyState.Actions": EmptyState.Actions,
Fieldset,
Notification: SafeNotification,
LoadingOverlay,
Rating: SafeRating,
// Navigation & structure
@@ -342,11 +627,30 @@ export const WHITELISTED_COMPONENTS: Record<string, ComponentType<never>> = {
SankeyChart,
Treemap,
BarsList,
ChartLegend,
ChartTooltip,
// Dates
Calendar: SafeCalendar,
MiniCalendar: SafeMiniCalendar,
DatePicker: SafeDatePicker,
Day: createSafeDateComponent(Day),
WeekdaysRow: createSafeDateComponent(WeekdaysRow),
Month: createSafeDateComponent(Month),
CalendarHeader: createSafeDateComponent(CalendarHeader),
YearPicker: createSafeDateComponent(YearPicker),
MonthPicker: createSafeDateComponent(MonthPicker),
TimeGrid: createSafeDateComponent(TimeGrid),
PickerControl: createSafeDateComponent(PickerControl),
YearsList: createSafeDateComponent(YearsList),
MonthsList: createSafeDateComponent(MonthsList),
DecadeLevel: createSafeDateComponent(DecadeLevel),
YearLevel: createSafeDateComponent(YearLevel),
MonthLevel: createSafeDateComponent(MonthLevel),
LevelsGroup: createSafeDateComponent(LevelsGroup),
DecadeLevelGroup: createSafeDateComponent(DecadeLevelGroup),
YearLevelGroup: createSafeDateComponent(YearLevelGroup),
MonthLevelGroup: createSafeDateComponent(MonthLevelGroup),
TimeValue,
// Custom interactive components (own state management)
@@ -356,6 +660,7 @@ export const WHITELISTED_COMPONENTS: Record<string, ComponentType<never>> = {
Collapsible,
StatBar,
TypeBadge,
TablerIcon: SafeTablerIcon,
// SubFetch — server-proxied HTTP from within templates
SubFetch,
@@ -365,6 +670,12 @@ export const WHITELISTED_COMPONENTS: Record<string, ComponentType<never>> = {
RefreshButton,
};
const enabledComponentNames = new Set(enabledCustomJsxComponents.map(({ name }) => name));
export const WHITELISTED_COMPONENTS: Record<string, ComponentType<never>> = Object.fromEntries(
Object.entries(RUNTIME_COMPONENTS).filter(([name]) => enabledComponentNames.has(name)),
);
function sanitizeData(obj: unknown): unknown {
if (obj === null || obj === undefined) return obj;
if (typeof obj !== "object") return obj;
@@ -379,60 +690,63 @@ function sanitizeData(obj: unknown): unknown {
}
const safeMath: Record<string, unknown> = Object.create(null);
safeMath.round = (v: number) => Math.round(v);
safeMath.floor = (v: number) => Math.floor(v);
safeMath.ceil = (v: number) => Math.ceil(v);
safeMath.abs = (v: number) => Math.abs(v);
safeMath.min = (...args: number[]) => Math.min(...args);
safeMath.max = (...args: number[]) => Math.max(...args);
safeMath.pow = (b: number, e: number) => Math.pow(b, e);
safeMath.sqrt = (v: number) => Math.sqrt(v);
safeMath.round = createSafeCallable((v: number) => Math.round(v));
safeMath.floor = createSafeCallable((v: number) => Math.floor(v));
safeMath.ceil = createSafeCallable((v: number) => Math.ceil(v));
safeMath.abs = createSafeCallable((v: number) => Math.abs(v));
safeMath.min = createSafeCallable((...args: number[]) => Math.min(...args));
safeMath.max = createSafeCallable((...args: number[]) => Math.max(...args));
safeMath.pow = createSafeCallable((b: number, e: number) => Math.pow(b, e));
safeMath.sqrt = createSafeCallable((v: number) => Math.sqrt(v));
safeMath.PI = Math.PI;
Object.freeze(safeMath);
const safeJSON: Record<string, unknown> = Object.create(null);
safeJSON.stringify = (v: unknown) => JSON.stringify(v);
safeJSON.stringify = createSafeCallable((v: unknown) => JSON.stringify(v));
Object.freeze(safeJSON);
const safeArray: Record<string, unknown> = Object.create(null);
safeArray.isArray = (v: unknown) => Array.isArray(v);
safeArray.from = <T>(v: ArrayLike<T> | Iterable<T>) => Array.from(v);
safeArray.isArray = createSafeCallable((v: unknown) => Array.isArray(v));
safeArray.from = createSafeCallable((v: ArrayLike<unknown> | Iterable<unknown>) => Array.from(v).slice(0, 2_000));
Object.freeze(safeArray);
const safeObject: Record<string, unknown> = Object.create(null);
safeObject.keys = (v: object) => Object.keys(v);
safeObject.values = (v: object) => Object.values(v);
safeObject.entries = (v: object) => Object.entries(v);
safeObject.keys = createSafeCallable((v: object) => Object.keys(v));
safeObject.values = createSafeCallable((v: object) => Object.values(v));
safeObject.entries = createSafeCallable((v: object) => Object.entries(v));
Object.freeze(safeObject);
const safeDate: Record<string, unknown> = Object.create(null);
safeDate.now = () => Date.now();
safeDate.create = (v?: string | number) => (v != null ? new Date(v) : new Date());
safeDate.toISOString = (v: string | number) => new Date(v).toISOString();
safeDate.toLocaleDateString = (v: string | number, locale?: string) =>
new Date(v).toLocaleDateString(locale ?? "en-US");
safeDate.toLocaleTimeString = (v: string | number, locale?: string) =>
new Date(v).toLocaleTimeString(locale ?? "en-US");
safeDate.getTime = (v: string | number) => new Date(v).getTime();
safeDate.getYear = (v: string | number) => new Date(v).getFullYear();
safeDate.getMonth = (v: string | number) => new Date(v).getMonth();
safeDate.getDay = (v: string | number) => new Date(v).getDate();
safeDate.now = createSafeCallable(() => Date.now());
// Date helpers return primitives only; native Date instances never enter the interpreter.
safeDate.create = createSafeCallable((v?: string | number) => (v != null ? new Date(v).getTime() : Date.now()));
safeDate.toISOString = createSafeCallable((v: string | number) => new Date(v).toISOString());
safeDate.toLocaleDateString = createSafeCallable((v: string | number, locale?: string) =>
new Date(v).toLocaleDateString(locale ?? "en-US"),
);
safeDate.toLocaleTimeString = createSafeCallable((v: string | number, locale?: string) =>
new Date(v).toLocaleTimeString(locale ?? "en-US"),
);
safeDate.getTime = createSafeCallable((v: string | number) => new Date(v).getTime());
safeDate.getYear = createSafeCallable((v: string | number) => new Date(v).getFullYear());
safeDate.getMonth = createSafeCallable((v: string | number) => new Date(v).getMonth());
safeDate.getDay = createSafeCallable((v: string | number) => new Date(v).getDay());
Object.freeze(safeDate);
export const SAFE_BINDINGS = (apiData: unknown) => ({
data: sanitizeData(apiData),
String: (v: unknown) => String(v),
Number: (v: unknown) => Number(v),
Boolean: (v: unknown) => Boolean(v),
String: createSafeCallable((v: unknown) => String(v)),
Number: createSafeCallable((v: unknown) => Number(v)),
Boolean: createSafeCallable((v: unknown) => Boolean(v)),
Math: safeMath,
JSON: safeJSON,
Array: safeArray,
Object: safeObject,
Date: safeDate,
parseInt: (v: string, radix?: number) => parseInt(v, radix),
parseFloat: (v: string) => parseFloat(v),
encodeURIComponent: (v: string) => encodeURIComponent(v),
decodeURIComponent: (v: string) => decodeURIComponent(v),
isNaN: (v: unknown) => Number.isNaN(Number(v)),
isFinite: (v: unknown) => Number.isFinite(Number(v)),
parseInt: createSafeCallable((v: string, radix?: number) => parseInt(v, radix)),
parseFloat: createSafeCallable((v: string) => parseFloat(v)),
encodeURIComponent: createSafeCallable((v: string) => encodeURIComponent(v)),
decodeURIComponent: createSafeCallable((v: string) => decodeURIComponent(v)),
isNaN: createSafeCallable((v: unknown) => Number.isNaN(Number(v))),
isFinite: createSafeCallable((v: unknown) => Number.isFinite(Number(v))),
});