feat: reuse integrations in custom widgets
This commit is contained in:
1 parent
c32a5317ca
commit
52c82f72db
49 files changed
+793
-269
No files matched your search
@@ -3,10 +3,30 @@
|
||||
Most widgets use a single source named `default`; the manifest must contain it. Extra keyed sources are available for widgets
|
||||
that combine APIs. Source IDs are case-insensitively unique. Base URLs must use HTTP(S), contain no embedded credentials,
|
||||
query string, or fragment, and sources can be `public`, `private`, or `loopback`. Authentication is `none`, `bearer`,
|
||||
`basic`, an API-key header, or an API-key query parameter. Credentials belong to the widget but remain outside its manifest.
|
||||
`basic`, an API-key header, or an API-key query parameter. HTTP source credentials belong to the widget but remain outside its manifest.
|
||||
Source origins are fixed by the definition and source-setup flow; widget options and invocation parameters cannot redirect a
|
||||
request to a different origin.
|
||||
|
||||
## Existing integrations
|
||||
|
||||
Sonarr and Radarr sources can reuse a configured integration:
|
||||
|
||||
```json
|
||||
{
|
||||
"sources": { "default": { "type": "integration", "integrationKind": "sonarr" } },
|
||||
"requests": { "queue": { "path": "/api/v3/queue" } }
|
||||
}
|
||||
```
|
||||
|
||||
Select the local instance during source setup. Homarr uses its current URL, API key, and trusted certificates;
|
||||
paths append to the saved URL, including reverse-proxy subpaths. Changing the integration updates all sources bound to it.
|
||||
Deleting it leaves the widget unconfigured until another instance is selected. The binding is shared by every placement
|
||||
of that widget definition. Exports and Workshop submissions retain the required type and omit the local integration ID.
|
||||
|
||||
Integration requests require integration `use` access for GET queries, `interact` for actions, and `full` for DELETE,
|
||||
in addition to the request's board permission. Board access alone does not grant integration access. Methods other than
|
||||
GET must be manual actions. Requests and redirects must stay within the configured integration's URL path.
|
||||
|
||||
## Named requests
|
||||
|
||||
Requests are keyed by ID. `source`, `kind`, `method`, `trigger`, `auth`, and `permission` have sensible defaults, so a load query can be as small as:
|
||||
|
||||
+40
-22
@@ -16,6 +16,9 @@ import {
|
||||
} from "@mantine/core";
|
||||
import { IconCheck, IconKey, IconLock } from "@tabler/icons-react";
|
||||
|
||||
import type { CustomWidgetSource } from "@homarr/custom-widgets/core";
|
||||
import { IntegrationSourceSelect } from "~/components/custom-widgets/integration-source-select";
|
||||
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
|
||||
interface RequestDetails {
|
||||
@@ -24,10 +27,7 @@ interface RequestDetails {
|
||||
kinds: Array<"apiKey" | "username" | "password">;
|
||||
expiresAt: number;
|
||||
status: "pending" | "completed";
|
||||
source: {
|
||||
baseUrl: string;
|
||||
networkScope: "public" | "private" | "loopback";
|
||||
};
|
||||
source: CustomWidgetSource;
|
||||
}
|
||||
|
||||
export function CustomWidgetConfigurationEntry({ token }: { token: string }) {
|
||||
@@ -35,6 +35,7 @@ export function CustomWidgetConfigurationEntry({ token }: { token: string }) {
|
||||
const tSecret = useI18n("customWidget.secret");
|
||||
const [details, setDetails] = useState<RequestDetails | null>(null);
|
||||
const [values, setValues] = useState<Record<string, string>>({});
|
||||
const [integrationId, setIntegrationId] = useState<string>();
|
||||
const [baseUrl, setBaseUrl] = useState("");
|
||||
const [networkScope, setNetworkScope] = useState<"public" | "private" | "loopback">("public");
|
||||
const [error, setError] = useState<string | null>(null);
|
||||
@@ -47,8 +48,9 @@ export function CustomWidgetConfigurationEntry({ token }: { token: string }) {
|
||||
const body = (await response.json()) as RequestDetails | { error: string };
|
||||
if (!response.ok || "error" in body) throw new Error("error" in body ? body.error : t("unavailable"));
|
||||
setDetails(body);
|
||||
setBaseUrl(body.source.baseUrl);
|
||||
setNetworkScope(body.source.networkScope);
|
||||
setBaseUrl(body.source.baseUrl ?? "");
|
||||
setNetworkScope(body.source.networkScope ?? "public");
|
||||
setIntegrationId(body.source.integrationId);
|
||||
})
|
||||
.catch((cause: unknown) => setError(cause instanceof Error ? cause.message : t("unavailable")))
|
||||
.finally(() => setLoading(false));
|
||||
@@ -58,10 +60,12 @@ export function CustomWidgetConfigurationEntry({ token }: { token: string }) {
|
||||
setSaving(true);
|
||||
setError(null);
|
||||
try {
|
||||
let configuration: unknown = { baseUrl, networkScope, secrets: values };
|
||||
if (details?.source.type === "integration") configuration = { integrationId, secrets: {} };
|
||||
const response = await fetch(`/api/custom-widgets/configuration-request/${encodeURIComponent(token)}`, {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({ baseUrl, networkScope, secrets: values }),
|
||||
body: JSON.stringify(configuration),
|
||||
});
|
||||
const body = (await response.json()) as { status?: string; error?: string };
|
||||
if (!response.ok) throw new Error(body.error ?? t("saveError"));
|
||||
@@ -102,20 +106,31 @@ export function CustomWidgetConfigurationEntry({ token }: { token: string }) {
|
||||
{t("source", { name: details.sourceName })}
|
||||
</Text>
|
||||
</Card>
|
||||
<TextInput
|
||||
label={t("baseUrl")}
|
||||
type="url"
|
||||
value={baseUrl}
|
||||
onChange={(event) => setBaseUrl(event.currentTarget.value)}
|
||||
required
|
||||
/>
|
||||
<Select
|
||||
label={t("networkScope")}
|
||||
data={["public", "private", "loopback"]}
|
||||
value={networkScope}
|
||||
allowDeselect={false}
|
||||
onChange={(value) => value && setNetworkScope(value as typeof networkScope)}
|
||||
/>
|
||||
{details.source.type === "integration" && (
|
||||
<IntegrationSourceSelect
|
||||
kind={details.source.integrationKind}
|
||||
integrationId={integrationId}
|
||||
onChange={setIntegrationId}
|
||||
/>
|
||||
)}
|
||||
{details.source.type !== "integration" && (
|
||||
<>
|
||||
<TextInput
|
||||
label={t("baseUrl")}
|
||||
type="url"
|
||||
value={baseUrl}
|
||||
onChange={(event) => setBaseUrl(event.currentTarget.value)}
|
||||
required
|
||||
/>
|
||||
<Select
|
||||
label={t("networkScope")}
|
||||
data={["public", "private", "loopback"]}
|
||||
value={networkScope}
|
||||
allowDeselect={false}
|
||||
onChange={(value) => value && setNetworkScope(value as typeof networkScope)}
|
||||
/>
|
||||
</>
|
||||
)}
|
||||
{details.kinds.map((kind) => {
|
||||
const Input = kind === "username" ? TextInput : PasswordInput;
|
||||
return (
|
||||
@@ -132,7 +147,10 @@ export function CustomWidgetConfigurationEntry({ token }: { token: string }) {
|
||||
})}
|
||||
<Button
|
||||
loading={saving}
|
||||
disabled={!URL.canParse(baseUrl) || details.kinds.some((kind) => !values[kind])}
|
||||
disabled={
|
||||
(details.source.type === "integration" ? !integrationId : !URL.canParse(baseUrl)) ||
|
||||
details.kinds.some((kind) => !values[kind])
|
||||
}
|
||||
onClick={() => void submit()}
|
||||
>
|
||||
{t("save")}
|
||||
|
||||
+122
-65
@@ -4,9 +4,15 @@ import { Button, Fieldset, Group, PasswordInput, Select, Stack, TextInput } from
|
||||
import { IconKey, IconTrash } from "@tabler/icons-react";
|
||||
|
||||
import { getCustomWidgetSourceUrlIssue } from "@homarr/custom-widgets/core";
|
||||
import type { CustomWidgetSource, CustomWidgetSourceUrlIssue } from "@homarr/custom-widgets/core";
|
||||
import type {
|
||||
CustomWidgetHttpSource,
|
||||
CustomWidgetSource,
|
||||
CustomWidgetSourceUrlIssue,
|
||||
} from "@homarr/custom-widgets/core";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
|
||||
import { IntegrationSourceSelect } from "~/components/custom-widgets/integration-source-select";
|
||||
|
||||
import type { CustomWidgetWorkbenchForm } from "./_custom-widget-form-utils";
|
||||
import { CustomWidgetIdentifierInput } from "./_custom-widget-identifier-input";
|
||||
|
||||
@@ -52,9 +58,6 @@ export function CustomWidgetSourceField({
|
||||
onRemove,
|
||||
}: CustomWidgetSourceFieldProps) {
|
||||
const t = useI18n("customWidget.workbench.sources");
|
||||
const tSecret = useI18n("customWidget.secret");
|
||||
const baseUrlIssue = getCustomWidgetSourceUrlIssue(source.baseUrl);
|
||||
const authType = typeof source.auth === "string" ? source.auth : source.auth.type;
|
||||
|
||||
return (
|
||||
<Fieldset legend={index === 0 ? t("primary") : source.name}>
|
||||
@@ -73,72 +76,41 @@ export function CustomWidgetSourceField({
|
||||
onChange={(event) => onUpdate(index, { name: event.currentTarget.value })}
|
||||
/>
|
||||
</Group>
|
||||
<TextInput
|
||||
label={t("baseUrl")}
|
||||
type="url"
|
||||
value={source.baseUrl}
|
||||
error={baseUrlIssue ? t(sourceUrlErrorKeys[baseUrlIssue]) : undefined}
|
||||
onChange={(event) => onUpdate(index, { baseUrl: event.currentTarget.value })}
|
||||
<Select
|
||||
label={t("sourceType")}
|
||||
data={[
|
||||
{ value: "http", label: t("manualSource") },
|
||||
{ value: "integration", label: t("existingIntegration") },
|
||||
]}
|
||||
value={source.type ?? "http"}
|
||||
allowDeselect={false}
|
||||
onChange={(type) => {
|
||||
if (type === "integration") onUpdate(index, { type, integrationKind: "sonarr" });
|
||||
else if (type === "http")
|
||||
onUpdate(index, { type, baseUrl: "https://example.com", networkScope: "public", auth: "none" });
|
||||
}}
|
||||
/>
|
||||
<Group grow align="start">
|
||||
<Select
|
||||
label={t("networkScope")}
|
||||
data={["public", "private", "loopback"]}
|
||||
value={source.networkScope}
|
||||
onChange={(value) =>
|
||||
value && onUpdate(index, { networkScope: value as CustomWidgetSource["networkScope"] })
|
||||
}
|
||||
allowDeselect={false}
|
||||
/>
|
||||
<Select
|
||||
label={t("authentication")}
|
||||
data={["none", "bearer", "basic", "apiKeyHeader", "apiKeyQuery"]}
|
||||
value={authType}
|
||||
onChange={(value) => onSetAuthentication(index, value ?? "none")}
|
||||
allowDeselect={false}
|
||||
/>
|
||||
</Group>
|
||||
{typeof source.auth === "object" && source.auth.type === "apiKeyHeader" && (
|
||||
<TextInput
|
||||
label={t("headerName")}
|
||||
value={source.auth.name}
|
||||
onChange={(event) => onUpdate(index, { auth: { type: "apiKeyHeader", name: event.currentTarget.value } })}
|
||||
{source.type === "integration" && (
|
||||
<IntegrationSourceSelect
|
||||
kind={source.integrationKind}
|
||||
integrationId={source.integrationId}
|
||||
onChange={(integrationId) => onUpdate(index, { integrationId })}
|
||||
onKindChange={(integrationKind) => onUpdate(index, { integrationKind, integrationId: undefined })}
|
||||
/>
|
||||
)}
|
||||
{typeof source.auth === "object" && source.auth.type === "apiKeyQuery" && (
|
||||
<TextInput
|
||||
label={t("queryParameter")}
|
||||
value={source.auth.name}
|
||||
onChange={(event) => onUpdate(index, { auth: { type: "apiKeyQuery", name: event.currentTarget.value } })}
|
||||
{source.type !== "integration" && (
|
||||
<CustomWidgetHttpSourceFields
|
||||
source={source}
|
||||
index={index}
|
||||
form={form}
|
||||
definitionId={definitionId}
|
||||
clearSecretPending={clearSecretPending}
|
||||
onUpdate={onUpdate}
|
||||
onSetAuthentication={onSetAuthentication}
|
||||
onSetSecret={onSetSecret}
|
||||
onClearSecret={onClearSecret}
|
||||
/>
|
||||
)}
|
||||
{(secretFields[authType] ?? []).map(({ kind }) => {
|
||||
const secret = form.values.secrets.find((entry) => entry.sourceId === source.id && entry.kind === kind);
|
||||
const Input = kind === "username" ? TextInput : PasswordInput;
|
||||
return (
|
||||
<Group key={kind} align="end" wrap="nowrap">
|
||||
<Input
|
||||
style={{ flex: 1 }}
|
||||
label={tSecret(kind)}
|
||||
value={secret?.value ?? ""}
|
||||
placeholder={secret?.hasValue ? t("configured") : undefined}
|
||||
leftSection={<IconKey size={15} />}
|
||||
onChange={(event) => onSetSecret(source.id, kind, event.currentTarget.value)}
|
||||
/>
|
||||
{definitionId && secret?.hasValue && (
|
||||
<Button
|
||||
type="button"
|
||||
color="red"
|
||||
variant="subtle"
|
||||
loading={clearSecretPending}
|
||||
onClick={() => void onClearSecret(source.id, kind)}
|
||||
>
|
||||
{t("clear")}
|
||||
</Button>
|
||||
)}
|
||||
</Group>
|
||||
);
|
||||
})}
|
||||
{index > 0 && (
|
||||
<Button
|
||||
type="button"
|
||||
@@ -154,3 +126,88 @@ export function CustomWidgetSourceField({
|
||||
</Fieldset>
|
||||
);
|
||||
}
|
||||
|
||||
function CustomWidgetHttpSourceFields({
|
||||
source,
|
||||
index,
|
||||
form,
|
||||
definitionId,
|
||||
clearSecretPending,
|
||||
onUpdate,
|
||||
onSetAuthentication,
|
||||
onSetSecret,
|
||||
onClearSecret,
|
||||
}: Omit<CustomWidgetSourceFieldProps, "source" | "onRemove"> & { source: CustomWidgetHttpSource & { id: string } }) {
|
||||
const t = useI18n("customWidget.workbench.sources");
|
||||
const tSecret = useI18n("customWidget.secret");
|
||||
const baseUrlIssue = getCustomWidgetSourceUrlIssue(source.baseUrl);
|
||||
const authType = typeof source.auth === "string" ? source.auth : source.auth.type;
|
||||
return (
|
||||
<>
|
||||
<TextInput
|
||||
label={t("baseUrl")}
|
||||
type="url"
|
||||
value={source.baseUrl}
|
||||
error={baseUrlIssue ? t(sourceUrlErrorKeys[baseUrlIssue]) : undefined}
|
||||
onChange={(event) => onUpdate(index, { baseUrl: event.currentTarget.value })}
|
||||
/>
|
||||
<Group grow align="start">
|
||||
<Select
|
||||
label={t("networkScope")}
|
||||
data={["public", "private", "loopback"]}
|
||||
value={source.networkScope}
|
||||
onChange={(value) => value && onUpdate(index, { networkScope: value as CustomWidgetSource["networkScope"] })}
|
||||
allowDeselect={false}
|
||||
/>
|
||||
<Select
|
||||
label={t("authentication")}
|
||||
data={["none", "bearer", "basic", "apiKeyHeader", "apiKeyQuery"]}
|
||||
value={authType}
|
||||
onChange={(value) => onSetAuthentication(index, value ?? "none")}
|
||||
allowDeselect={false}
|
||||
/>
|
||||
</Group>
|
||||
{typeof source.auth === "object" && source.auth.type === "apiKeyHeader" && (
|
||||
<TextInput
|
||||
label={t("headerName")}
|
||||
value={source.auth.name}
|
||||
onChange={(event) => onUpdate(index, { auth: { type: "apiKeyHeader", name: event.currentTarget.value } })}
|
||||
/>
|
||||
)}
|
||||
{typeof source.auth === "object" && source.auth.type === "apiKeyQuery" && (
|
||||
<TextInput
|
||||
label={t("queryParameter")}
|
||||
value={source.auth.name}
|
||||
onChange={(event) => onUpdate(index, { auth: { type: "apiKeyQuery", name: event.currentTarget.value } })}
|
||||
/>
|
||||
)}
|
||||
{(secretFields[authType] ?? []).map(({ kind }) => {
|
||||
const secret = form.values.secrets.find((entry) => entry.sourceId === source.id && entry.kind === kind);
|
||||
const Input = kind === "username" ? TextInput : PasswordInput;
|
||||
return (
|
||||
<Group key={kind} align="end" wrap="nowrap">
|
||||
<Input
|
||||
style={{ flex: 1 }}
|
||||
label={tSecret(kind)}
|
||||
value={secret?.value ?? ""}
|
||||
placeholder={secret?.hasValue ? t("configured") : undefined}
|
||||
leftSection={<IconKey size={15} />}
|
||||
onChange={(event) => onSetSecret(source.id, kind, event.currentTarget.value)}
|
||||
/>
|
||||
{definitionId && secret?.hasValue && (
|
||||
<Button
|
||||
type="button"
|
||||
color="red"
|
||||
variant="subtle"
|
||||
loading={clearSecretPending}
|
||||
onClick={() => void onClearSecret(source.id, kind)}
|
||||
>
|
||||
{t("clear")}
|
||||
</Button>
|
||||
)}
|
||||
</Group>
|
||||
);
|
||||
})}
|
||||
</>
|
||||
);
|
||||
}
|
||||
+7
-1
@@ -28,6 +28,12 @@ export function CustomWidgetSourcesEditor({
|
||||
const clearSecretMutation = clientApi.customWidget.secretClear.useMutation();
|
||||
const sources = parseSources(form.values.sources);
|
||||
const update = (index: number, changes: Partial<CustomWidgetSource> & { id?: string }) => {
|
||||
if (changes.type) {
|
||||
form.setFieldValue(
|
||||
"secrets",
|
||||
form.values.secrets.filter((secret) => secret.sourceId !== sources[index]?.id),
|
||||
);
|
||||
}
|
||||
const previousId = sources[index]?.id;
|
||||
const nextId = changes.id ?? previousId;
|
||||
if (nextId && sources.some((source, sourceIndex) => sourceIndex !== index && source.id === nextId)) {
|
||||
@@ -42,7 +48,7 @@ export function CustomWidgetSourcesEditor({
|
||||
Object.fromEntries(
|
||||
sourceEntries.map(([id, source], i) => [
|
||||
i === index ? nextId : id,
|
||||
i === index ? { ...source, ...changes, id: undefined } : source,
|
||||
i === index ? { ...(changes.type ? { name: source.name } : source), ...changes, id: undefined } : source,
|
||||
]),
|
||||
),
|
||||
null,
|
||||
|
||||
+3
-2
@@ -1,5 +1,6 @@
|
||||
"use client";
|
||||
|
||||
import { SourceSetupPanel } from "~/components/custom-widgets/source-setup-panel";
|
||||
import { useRouter } from "next/navigation";
|
||||
import { useMemo } from "react";
|
||||
import {
|
||||
@@ -22,7 +23,7 @@ import { IconAlertTriangle, IconArrowLeft, IconDownload, IconExternalLink, IconF
|
||||
|
||||
import { CUSTOM_WIDGET_SCHEMA } from "@homarr/custom-widgets/core";
|
||||
import type { HomarrCustomWidgetV2 } from "@homarr/custom-widgets/core";
|
||||
import { CustomWidgetSourceSetupPanel, ImportReviewContent } from "@homarr/custom-widgets/workbench";
|
||||
import { ImportReviewContent } from "@homarr/custom-widgets/workbench";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
import { Link } from "@homarr/ui";
|
||||
import { useWorkshopReportSummariesQuery, useWorkshopSubmissionQuery } from "@homarr/workshop/backend";
|
||||
@@ -190,7 +191,7 @@ export function WorkshopDetail({ id }: { id: string }) {
|
||||
</Text>
|
||||
</Box>
|
||||
<ImportReviewContent review={importer.review} messages={importer.reviewMessages}>
|
||||
<CustomWidgetSourceSetupPanel
|
||||
<SourceSetupPanel
|
||||
setups={importer.setups}
|
||||
values={importer.values}
|
||||
onChange={importer.setValue}
|
||||
|
||||
@@ -3,6 +3,7 @@ import { NextResponse } from "next/server";
|
||||
|
||||
import {
|
||||
claimCustomWidgetConfigurationRequest,
|
||||
assertCustomWidgetIntegrationBindings,
|
||||
completeCustomWidgetConfigurationRequest,
|
||||
configureCustomWidgetSourceFromRequest,
|
||||
configurePreviewSessionSource,
|
||||
@@ -12,6 +13,7 @@ import {
|
||||
import { customWidgetSourceSchema } from "@homarr/custom-widgets/core";
|
||||
import { invalidateCustomWidgetResponseCache } from "@homarr/custom-widgets/server";
|
||||
import { db } from "@homarr/db";
|
||||
import { auth } from "@homarr/auth/next";
|
||||
|
||||
import { adminRoute } from "../../admin";
|
||||
import { readConfigurationRequestBody } from "../body";
|
||||
@@ -52,17 +54,40 @@ const completeConfigurationRequest = async (request: NextRequest, context: Route
|
||||
return NextResponse.json({ error: "Enter a valid source configuration." }, { status: 400 });
|
||||
}
|
||||
const body = parsedBody.data;
|
||||
const sourceResult = customWidgetSourceSchema.safeParse({
|
||||
...pending.source,
|
||||
baseUrl: body.baseUrl,
|
||||
networkScope: body.networkScope,
|
||||
});
|
||||
let candidate: unknown;
|
||||
if (pending.source.type === "integration") {
|
||||
if (
|
||||
!body.integrationId ||
|
||||
body.baseUrl !== undefined ||
|
||||
body.networkScope !== undefined ||
|
||||
Object.keys(body.secrets).length > 0
|
||||
) {
|
||||
return NextResponse.json({ error: "Select an existing integration." }, { status: 400 });
|
||||
}
|
||||
candidate = { ...pending.source, integrationId: body.integrationId };
|
||||
} else {
|
||||
if (body.integrationId)
|
||||
return NextResponse.json({ error: "HTTP sources cannot bind an integration." }, { status: 400 });
|
||||
candidate = { ...pending.source, baseUrl: body.baseUrl, networkScope: body.networkScope };
|
||||
}
|
||||
const sourceResult = customWidgetSourceSchema.safeParse(candidate);
|
||||
if (!sourceResult.success) {
|
||||
return NextResponse.json(
|
||||
{ error: sourceResult.error.issues[0]?.message ?? "Enter a valid server URL." },
|
||||
{ status: 400 },
|
||||
);
|
||||
}
|
||||
try {
|
||||
await assertCustomWidgetIntegrationBindings(
|
||||
{ db, session: await auth() },
|
||||
{ [pending.sourceId]: sourceResult.data },
|
||||
);
|
||||
} catch {
|
||||
return NextResponse.json(
|
||||
{ error: "The selected integration is unavailable or has a different type." },
|
||||
{ status: 400 },
|
||||
);
|
||||
}
|
||||
const secrets = pending.kinds.flatMap((kind) => {
|
||||
const value = body.secrets[kind];
|
||||
return typeof value === "string" && value.length > 0 && value.length <= 8192
|
||||
@@ -95,6 +120,7 @@ const completeConfigurationRequest = async (request: NextRequest, context: Route
|
||||
const result = await configureCustomWidgetSourceFromRequest(db, {
|
||||
definitionId: claimed.target.id,
|
||||
sourceId: claimed.sourceId,
|
||||
integrationId: sourceResult.data.integrationId,
|
||||
baseUrl: sourceResult.data.baseUrl,
|
||||
networkScope: sourceResult.data.networkScope,
|
||||
secrets,
|
||||
|
||||
@@ -1,11 +1,17 @@
|
||||
import { z } from "zod/v4";
|
||||
|
||||
export const MAX_CONFIGURATION_REQUEST_BODY_BYTES = 24 * 1024;
|
||||
const configurationRequestBodySchema = z.strictObject({
|
||||
baseUrl: z.string(),
|
||||
networkScope: z.enum(["public", "private", "loopback"]),
|
||||
secrets: z.record(z.string(), z.string()),
|
||||
});
|
||||
const configurationRequestBodySchema = z
|
||||
.strictObject({
|
||||
baseUrl: z.string().optional(),
|
||||
integrationId: z.string().min(1).max(100).optional(),
|
||||
networkScope: z.enum(["public", "private", "loopback"]).optional(),
|
||||
secrets: z.record(z.string(), z.string()),
|
||||
})
|
||||
.refine(
|
||||
(value) => Boolean(value.integrationId) || (value.baseUrl !== undefined && value.networkScope !== undefined),
|
||||
"Provide an integration or HTTP connection",
|
||||
);
|
||||
|
||||
export async function readConfigurationRequestBody(
|
||||
request: Request,
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
"use client";
|
||||
|
||||
import { SourceSetupPanel } from "~/components/custom-widgets/source-setup-panel";
|
||||
import type { ModalProps } from "@mantine/core";
|
||||
|
||||
import type { HomarrCustomWidgetV2 } from "@homarr/custom-widgets/core";
|
||||
import { CustomWidgetSourceSetupPanel, ImportReviewDialog } from "@homarr/custom-widgets/workbench";
|
||||
import { ImportReviewDialog } from "@homarr/custom-widgets/workbench";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
|
||||
import { useCustomWidgetImport } from "./use-custom-widget-import";
|
||||
@@ -67,7 +68,7 @@ export function CustomWidgetImportDialog({
|
||||
confirm: legacyId ? t("importReview.confirmMigration") : (labels?.confirm ?? t("importReview.confirm")),
|
||||
}}
|
||||
>
|
||||
<CustomWidgetSourceSetupPanel
|
||||
<SourceSetupPanel
|
||||
setups={importer.setups}
|
||||
values={importer.values}
|
||||
onChange={importer.setValue}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
"use client";
|
||||
|
||||
import { SourceSetupPanel } from "~/components/custom-widgets/source-setup-panel";
|
||||
import { useRouter } from "next/navigation";
|
||||
import { useEffect, useMemo, useState } from "react";
|
||||
import { Button, Center, Group, Loader, Modal, Stack, Text } from "@mantine/core";
|
||||
@@ -8,11 +9,7 @@ import { clientApi } from "@homarr/api/client";
|
||||
import { revalidatePathActionAsync } from "@homarr/common/client";
|
||||
import { getCustomWidgetSourceSetups } from "@homarr/custom-widgets/core";
|
||||
import type { CustomWidgetSecretKind } from "@homarr/custom-widgets/core";
|
||||
import {
|
||||
createCustomWidgetSourceSetupValues,
|
||||
CustomWidgetSourceSetupPanel,
|
||||
isCustomWidgetSourceSetupReady,
|
||||
} from "@homarr/custom-widgets/workbench";
|
||||
import { createCustomWidgetSourceSetupValues, isCustomWidgetSourceSetupReady } from "@homarr/custom-widgets/workbench";
|
||||
import type { CustomWidgetSourceSetupMessages, CustomWidgetSourceSetupValue } from "@homarr/custom-widgets/workbench";
|
||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
@@ -68,6 +65,14 @@ export function CustomWidgetSourceSetupDialog({ definitionId, opened, onClose }:
|
||||
const secrets = Object.entries(value.secrets).flatMap(([kind, secret]) =>
|
||||
secret?.trim() ? [{ sourceId: setup.sourceId, kind: kind as CustomWidgetSecretKind, value: secret }] : [],
|
||||
);
|
||||
if (setup.integrationKind) {
|
||||
await configureMutation.mutateAsync({
|
||||
definitionId,
|
||||
sourceId: setup.sourceId,
|
||||
integrationId: value.integrationId,
|
||||
});
|
||||
continue;
|
||||
}
|
||||
await configureMutation.mutateAsync({
|
||||
definitionId,
|
||||
sourceId: setup.sourceId,
|
||||
@@ -109,7 +114,7 @@ export function CustomWidgetSourceSetupDialog({ definitionId, opened, onClose }:
|
||||
</Text>
|
||||
) : (
|
||||
<Stack gap="md">
|
||||
<CustomWidgetSourceSetupPanel
|
||||
<SourceSetupPanel
|
||||
setups={setups}
|
||||
values={values}
|
||||
messages={messages}
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
"use client";
|
||||
|
||||
import { Alert, Select, Stack, Text } from "@mantine/core";
|
||||
|
||||
import { clientApi } from "@homarr/api/client";
|
||||
import type { CustomWidgetIntegrationSource } from "@homarr/custom-widgets/core";
|
||||
import { customWidgetIntegrationKinds } from "@homarr/custom-widgets/core";
|
||||
import { integrationDefs } from "@homarr/definitions";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
|
||||
interface IntegrationSourceSelectProps {
|
||||
kind: CustomWidgetIntegrationSource["integrationKind"];
|
||||
integrationId?: string;
|
||||
onChange(integrationId: string | undefined): void;
|
||||
onKindChange?(kind: CustomWidgetIntegrationSource["integrationKind"]): void;
|
||||
}
|
||||
|
||||
export function IntegrationSourceSelect({ kind, integrationId, onChange, onKindChange }: IntegrationSourceSelectProps) {
|
||||
const t = useI18n("customWidget.workbench.sources");
|
||||
const query = clientApi.integration.all.useQuery();
|
||||
const integrations = (query.data ?? []).filter(
|
||||
(integration) => integration.kind === kind && integration.permissions.hasFullAccess,
|
||||
);
|
||||
const unavailable = Boolean(integrationId && query.isSuccess && !integrations.some(({ id }) => id === integrationId));
|
||||
return (
|
||||
<Stack gap="sm">
|
||||
{onKindChange && (
|
||||
<Select
|
||||
label={t("integrationType")}
|
||||
data={customWidgetIntegrationKinds.map((value) => ({ value, label: integrationDefs[value].name }))}
|
||||
value={kind}
|
||||
allowDeselect={false}
|
||||
onChange={(value) => {
|
||||
const selected = customWidgetIntegrationKinds.find((candidate) => candidate === value);
|
||||
if (selected) onKindChange(selected);
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
<Select
|
||||
label={t("selectIntegration")}
|
||||
description={integrationDefs[kind].name}
|
||||
data={integrations.map(({ id, name }) => ({ value: id, label: name }))}
|
||||
value={integrationId ?? null}
|
||||
searchable
|
||||
clearable
|
||||
disabled={query.isPending}
|
||||
nothingFoundMessage={t("noIntegrations")}
|
||||
error={unavailable && t("integrationUnavailable")}
|
||||
onChange={(value) => onChange(value ?? undefined)}
|
||||
/>
|
||||
{query.error && <Alert color="red">{query.error.message}</Alert>}
|
||||
<Text size="xs" c="dimmed">
|
||||
{t("integrationDescription")}
|
||||
</Text>
|
||||
</Stack>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
"use client";
|
||||
|
||||
import { customWidgetIntegrationKinds } from "@homarr/custom-widgets/core";
|
||||
import { CustomWidgetSourceSetupPanel } from "@homarr/custom-widgets/workbench";
|
||||
import type { CustomWidgetSourceSetupPanelProps } from "@homarr/custom-widgets/workbench";
|
||||
|
||||
import { IntegrationSourceSelect } from "./integration-source-select";
|
||||
|
||||
export function SourceSetupPanel(props: CustomWidgetSourceSetupPanelProps) {
|
||||
return (
|
||||
<CustomWidgetSourceSetupPanel
|
||||
{...props}
|
||||
renderIntegrationSource={(setup, value) => {
|
||||
const kind = customWidgetIntegrationKinds.find((candidate) => candidate === setup.integrationKind);
|
||||
if (!kind) return null;
|
||||
return (
|
||||
<IntegrationSourceSelect
|
||||
kind={kind}
|
||||
integrationId={value.integrationId}
|
||||
onChange={(integrationId) => props.onChange(setup.sourceId, { ...value, integrationId })}
|
||||
/>
|
||||
);
|
||||
}}
|
||||
/>
|
||||
);
|
||||
}
|
||||
@@ -60,7 +60,7 @@ export function useCustomWidgetImport({ widget, legacyId, onImported }: UseCusto
|
||||
Object.fromEntries(
|
||||
Object.entries(values).map(([sourceId, value]) => [
|
||||
sourceId,
|
||||
{ baseUrl: value.baseUrl, networkScope: value.networkScope },
|
||||
{ baseUrl: value.baseUrl, networkScope: value.networkScope, integrationId: value.integrationId },
|
||||
]),
|
||||
),
|
||||
),
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
interface PublishableWorkshopDefinition {
|
||||
sources: Record<string, { name?: string; networkScope: string }>;
|
||||
sources: Record<string, { name?: string; networkScope?: string }>;
|
||||
}
|
||||
|
||||
export const serializeWorkshopDefinition = (definition: unknown): string => {
|
||||
@@ -29,5 +29,5 @@ export async function publishWorkshopDefinition({
|
||||
|
||||
export const getPrivateWorkshopSourceNames = (definition: PublishableWorkshopDefinition | undefined) =>
|
||||
Object.entries(definition?.sources ?? {}).flatMap(([sourceId, source]) =>
|
||||
source.networkScope === "public" ? [] : [source.name ?? sourceId],
|
||||
source.networkScope === undefined || source.networkScope === "public" ? [] : [source.name ?? sourceId],
|
||||
);
|
||||
Reference in new issue
Block a user