feat: polish custom widgets and workshop

This commit is contained in:
Thomas Camlong committed 2026-07-22 19:33:09 +02:00
1 parent e94b4d4bc9
commit 0066c8bc28
98 files changed
+9097 -1624

No files matched your search

+53
View File
@@ -0,0 +1,53 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Workshop report</title>
</head>
<body style="margin: 0; padding: 0; background: #f4f4f4; font-family: Helvetica, Arial, sans-serif">
<table role="presentation" width="100%" cellpadding="0" cellspacing="0" style="background: #f4f4f4">
<tr>
<td align="center" style="padding: 50px 20px">
<table
role="presentation"
width="600"
cellpadding="0"
cellspacing="0"
style="width: 600px; max-width: 100%; background: #ffffff; border: 1px solid #dc2626"
>
<tr>
<td style="background: #991b1b; padding: 28px 36px; color: #ffffff">
<div style="font-size: 12px; font-weight: bold; letter-spacing: 1px; text-transform: uppercase">
Moderation alert
</div>
<div style="margin-top: 8px; font-size: 22px; font-weight: bold">A Workshop submission was reported</div>
</td>
</tr>
<tr>
<td style="padding: 36px; color: #18181b; font-size: 15px; line-height: 1.65">
<p style="margin: 0 0 18px">
<strong>{{reporterName}}</strong> reported <a href="{{submissionUrl}}">{{submissionTitle}}</a>.
</p>
<p style="margin: 0 0 8px; font-size: 12px; font-weight: bold; text-transform: uppercase; color: #991b1b">
{{category}}
</p>
<blockquote
style="margin: 0 0 26px; padding: 16px 18px; border-left: 3px solid #dc2626; background: #fef2f2"
>
{{explanation}}
</blockquote>
<a
href="{{adminUrl}}"
style="display: inline-block; padding: 12px 20px; background: #991b1b; color: #ffffff; font-weight: bold; text-decoration: none"
>
REVIEW REPORT
</a>
</td>
</tr>
</table>
</td>
</tr>
</table>
</body>
</html>
@@ -0,0 +1,44 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Workshop submission removed</title>
</head>
<body style="margin: 0; padding: 0; background: #f4f4f4; font-family: Helvetica, Arial, sans-serif">
<table role="presentation" width="100%" cellpadding="0" cellspacing="0" style="background: #f4f4f4">
<tr>
<td align="center" style="padding: 50px 20px">
<table
role="presentation"
width="600"
cellpadding="0"
cellspacing="0"
style="width: 600px; max-width: 100%; background: #ffffff; border: 1px solid #27272a"
>
<tr>
<td style="background: #18181b; padding: 28px 36px; color: #ffffff">
<div style="font-size: 12px; font-weight: bold; letter-spacing: 1px; text-transform: uppercase">
Homarr Workshop
</div>
<div style="margin-top: 8px; font-size: 22px; font-weight: bold">Your submission was removed</div>
</td>
</tr>
<tr>
<td style="padding: 36px; color: #18181b; font-size: 15px; line-height: 1.65">
<p style="margin: 0 0 18px">A Workshop administrator removed your submission:</p>
<div style="margin: 0 0 24px; padding: 16px 18px; border-left: 3px solid #dc2626; background: #fef2f2">
<strong>{{submissionTitle}}</strong>
</div>
<p style="margin: 0">
The submission is no longer available in Workshop. Widgets or CSS already installed by users are not
removed from their Homarr instances.
</p>
</td>
</tr>
</table>
</td>
</tr>
</table>
</body>
</html>
+105 -12
View File
@@ -22,6 +22,24 @@ const escapeHtml = (value) =>
.replaceAll('"', "&quot;")
.replaceAll("'", "&#039;");
const emailTemplate = (filename) => {
const hooksPath = $os.getenv("WORKSHOP_PB_HOOKS_DIR") || $filepath.dirname(__filepath);
return $os.readFile($filepath.join(hooksPath, filename));
};
const sendEmail = (app, recipientEmail, subject, text, html) => {
const sender = app.settings().meta;
app.newMailClient().send(
new MailerMessage({
from: { address: sender.senderAddress, name: sender.senderName },
to: [{ address: recipientEmail }],
subject,
text,
html,
}),
);
};
onRecordAfterCreateSuccess((event) => {
try {
const submission = event.app.findRecordById("submissions", event.record.get("submission"));
@@ -39,25 +57,100 @@ onRecordAfterCreateSuccess((event) => {
const submissionTitle = submission.getString("title");
const rawExcerpt = event.record.getString("content").slice(0, 280);
const submissionUrl = `${publicOrigin}/workshop/${submission.id}/`;
const sender = event.app.settings().meta;
const templatePath = $os.getenv("WORKSHOP_PB_HOOKS_DIR") || $filepath.dirname(__filepath);
const template = $os
.readFile($filepath.join(templatePath, "comment-email.html"))
const template = emailTemplate("comment-email.html")
.replaceAll("{{commenterName}}", escapeHtml(commenterName))
.replaceAll("{{submissionTitle}}", escapeHtml(submissionTitle))
.replaceAll("{{commentExcerpt}}", escapeHtml(rawExcerpt))
.replaceAll("{{submissionUrl}}", escapeHtml(submissionUrl));
const message = new MailerMessage({
from: { address: sender.senderAddress, name: sender.senderName },
to: [{ address: recipientEmail }],
subject: `${commenterName} commented on ${submissionTitle}`,
text: `${commenterName} commented on “${submissionTitle}”:\n\n${rawExcerpt}\n\n${submissionUrl}`,
html: template,
});
event.app.newMailClient().send(message);
sendEmail(
event.app,
recipientEmail,
`${commenterName} commented on ${submissionTitle}`,
`${commenterName} commented on “${submissionTitle}”:\n\n${rawExcerpt}\n\n${submissionUrl}`,
template,
);
} catch (error) {
console.log(`Workshop comment email failed for ${event.record.id}: ${error}`);
}
event.next();
}, "comments");
onRecordAfterCreateSuccess((event) => {
try {
const submission = event.app.findRecordById("submissions", event.record.get("submission"));
const reporter = event.app.findRecordById("users", event.record.get("reporter"));
const publicOrigin = $os.getenv("WORKSHOP_PUBLIC_ORIGIN").replace(/\/$/, "");
const admins = event.app
.findAllRecords("users")
.filter((user) => user.getBool("isAdmin") && Boolean(user.email()));
if (!publicOrigin || admins.length === 0) {
event.next();
return;
}
const reporterName = reporter.getString("displayName") || "A community member";
const submissionTitle = submission.getString("title");
const category = event.record.getString("category");
const explanation = event.record.getString("explanation");
const adminUrl = `${publicOrigin}/workshop/admin`;
const submissionUrl = `${publicOrigin}/workshop/${submission.id}/`;
const template = emailTemplate("report-email.html")
.replaceAll("{{reporterName}}", escapeHtml(reporterName))
.replaceAll("{{submissionTitle}}", escapeHtml(submissionTitle))
.replaceAll("{{category}}", escapeHtml(category))
.replaceAll("{{explanation}}", escapeHtml(explanation))
.replaceAll("{{adminUrl}}", escapeHtml(adminUrl))
.replaceAll("{{submissionUrl}}", escapeHtml(submissionUrl));
for (const admin of admins) {
try {
sendEmail(
event.app,
admin.email(),
`Workshop report: ${submissionTitle}`,
`${reporterName} reported “${submissionTitle}” for ${category}.\n\n${explanation}\n\nReview: ${adminUrl}`,
template,
);
} catch (error) {
console.log(`Workshop report email failed for admin ${admin.id}: ${error}`);
}
}
} catch (error) {
console.log(`Workshop report email failed for ${event.record.id}: ${error}`);
}
event.next();
}, "reports");
onRecordDeleteRequest((event) => {
const submissionId = event.record.id;
const submissionTitle = event.record.getString("title");
const authorId = event.record.get("author");
const actor = event.requestInfo().auth;
const notifyAuthor = actor && actor.getBool("isAdmin") && actor.id !== authorId;
event.next();
if (!notifyAuthor) return;
try {
const author = event.app.findRecordById("users", authorId);
const recipientEmail = author.email();
if (!recipientEmail) return;
const publicOrigin = $os.getenv("WORKSHOP_PUBLIC_ORIGIN").replace(/\/$/, "");
const workshopUrl = publicOrigin ? `${publicOrigin}/workshop/` : "";
const template = emailTemplate("submission-deleted-email.html").replaceAll(
"{{submissionTitle}}",
escapeHtml(submissionTitle),
);
const text = `A Workshop administrator removed your submission “${submissionTitle}”.${
workshopUrl ? `\n\nReturn to Workshop: ${workshopUrl}` : ""
}`;
sendEmail(event.app, recipientEmail, `Your Workshop submission was removed`, text, template);
} catch (error) {
console.log(`Workshop deletion email failed for ${submissionId}: ${error}`);
}
}, "submissions");