feat(custom-widgets): complete Custom JSX v2 (#6390)
This commit is contained in:
1 parent
60cbd7bb7a
commit
6aceb2fd1f
450 files changed
+39817
-20588
No files matched your search
@@ -0,0 +1,21 @@
|
||||
import { WorkshopBackend, type TypedWorkshopPocketBase } from "@homarr/workshop/backend";
|
||||
import type { WorkshopSubmissionSummary } from "@homarr/workshop/schema";
|
||||
|
||||
export type { WorkshopComment, WorkshopVote } from "@homarr/workshop/schema";
|
||||
|
||||
const backends = new Map<string, WorkshopBackend>();
|
||||
|
||||
export const getWorkshopBackend = (url: string): WorkshopBackend => {
|
||||
const normalizedUrl = url.replace(/\/$/u, "");
|
||||
const existing = backends.get(normalizedUrl);
|
||||
if (existing) return existing;
|
||||
const backend = new WorkshopBackend(normalizedUrl);
|
||||
backends.set(normalizedUrl, backend);
|
||||
return backend;
|
||||
};
|
||||
|
||||
export const getPocketBase = (url: string): TypedWorkshopPocketBase => getWorkshopBackend(url).pocketBase;
|
||||
|
||||
export type WorkshopSubmission = WorkshopSubmissionSummary & {
|
||||
content: string;
|
||||
};
|
||||
@@ -0,0 +1,21 @@
|
||||
import type { ClassValue } from "clsx";
|
||||
import { clsx } from "clsx";
|
||||
import { twMerge } from "tailwind-merge";
|
||||
|
||||
export function cn(...inputs: ClassValue[]) {
|
||||
return twMerge(clsx(inputs));
|
||||
}
|
||||
|
||||
export function errorMessage(caught: unknown, fallback: string) {
|
||||
return caught instanceof Error ? caught.message : fallback;
|
||||
}
|
||||
|
||||
export function oauthErrorMessage(caught: unknown) {
|
||||
const message = errorMessage(caught, "GitHub sign-in failed");
|
||||
if (/popup.*block|blocked.*popup/iu.test(message))
|
||||
return "GitHub sign-in popup was blocked. Allow popups for this site and try again.";
|
||||
if (/cancel|closed.*popup|popup.*closed/iu.test(message)) return "GitHub sign-in was cancelled before it completed.";
|
||||
if (/provider|oauth|redirect|callback|client.?id/iu.test(message))
|
||||
return "GitHub sign-in is not configured correctly on the Workshop server.";
|
||||
return message;
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
import { CUSTOM_WIDGET_STARTER } from "@homarr/custom-widgets/core";
|
||||
|
||||
import { validateSubmissionContent } from "./workshop-schema";
|
||||
|
||||
const validWidget = CUSTOM_WIDGET_STARTER;
|
||||
|
||||
describe("validateSubmissionContent", () => {
|
||||
it("accepts a valid homarr-custom-widget-v2 JSON", () => {
|
||||
expect(validateSubmissionContent("customWidget", JSON.stringify(validWidget)).success).toBe(true);
|
||||
});
|
||||
|
||||
it("rejects an old/unknown widget schema version", () => {
|
||||
const result = validateSubmissionContent(
|
||||
"customWidget",
|
||||
JSON.stringify({ ...validWidget, $schema: "homarr-custom-widget-v1" }),
|
||||
);
|
||||
expect(result.success).toBe(false);
|
||||
});
|
||||
|
||||
it("rejects widgets without a schema version", () => {
|
||||
const { $schema: _schema, ...widgetWithoutSchema } = validWidget;
|
||||
|
||||
expect(validateSubmissionContent("customWidget", JSON.stringify(widgetWithoutSchema)).success).toBe(false);
|
||||
});
|
||||
|
||||
it("rejects malformed widget JSON", () => {
|
||||
expect(validateSubmissionContent("customWidget", "{ not json").success).toBe(false);
|
||||
});
|
||||
|
||||
it("accepts non-empty CSS and rejects empty CSS", () => {
|
||||
expect(validateSubmissionContent("customCss", ".card { color: red; }").success).toBe(true);
|
||||
expect(validateSubmissionContent("customCss", " ").success).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,24 @@
|
||||
import { CUSTOM_WIDGET_SCHEMA, type HomarrCustomWidgetV2 } from "@homarr/custom-widgets/core";
|
||||
import {
|
||||
MAX_WORKSHOP_CSS_LENGTH,
|
||||
type WorkshopSubmissionType,
|
||||
validateWorkshopContent,
|
||||
WORKSHOP_CSS_SCHEMA,
|
||||
} from "@homarr/workshop/schema";
|
||||
|
||||
export type SubmissionType = WorkshopSubmissionType;
|
||||
export const WIDGET_SCHEMA_VERSION = CUSTOM_WIDGET_SCHEMA;
|
||||
export const CSS_SCHEMA_VERSION = WORKSHOP_CSS_SCHEMA;
|
||||
export const MAX_CSS_LENGTH = MAX_WORKSHOP_CSS_LENGTH;
|
||||
|
||||
export type WorkshopValidationResult =
|
||||
| { success: true; data: HomarrCustomWidgetV2 | string }
|
||||
| { success: false; error: string };
|
||||
|
||||
export const schemaVersionByType = {
|
||||
customWidget: WIDGET_SCHEMA_VERSION,
|
||||
customCss: CSS_SCHEMA_VERSION,
|
||||
} satisfies Record<SubmissionType, string>;
|
||||
|
||||
export const validateSubmissionContent = (type: SubmissionType, raw: string): WorkshopValidationResult =>
|
||||
validateWorkshopContent(type, raw);
|
||||
Reference in new issue
Block a user