feat(workshop): add social previews
This commit is contained in:
1 parent
6edf78acd7
commit
7833cca86b
7 files changed
+189
No files matched your search
@@ -10,6 +10,37 @@ const escapeHtml = (value) =>
|
||||
.replaceAll('"', """)
|
||||
.replaceAll("'", "'");
|
||||
|
||||
const renderWorkshopSocialHtml = (html, metadata) => {
|
||||
const title = escapeHtml(metadata.title);
|
||||
const description = escapeHtml(metadata.description);
|
||||
const url = escapeHtml(metadata.url);
|
||||
const image = escapeHtml(metadata.image);
|
||||
const imageAlt = escapeHtml(`${metadata.submissionTitle} preview`);
|
||||
const section = escapeHtml(metadata.section);
|
||||
const tags = [
|
||||
`<title>${title}</title>`,
|
||||
`<meta name="description" content="${description}">`,
|
||||
`<link rel="canonical" href="${url}">`,
|
||||
`<meta property="og:type" content="article">`,
|
||||
`<meta property="og:site_name" content="Homarr Workshop">`,
|
||||
`<meta property="og:title" content="${title}">`,
|
||||
`<meta property="og:description" content="${description}">`,
|
||||
`<meta property="og:url" content="${url}">`,
|
||||
`<meta property="article:section" content="${section}">`,
|
||||
`<meta name="twitter:card" content="summary_large_image">`,
|
||||
`<meta name="twitter:title" content="${title}">`,
|
||||
`<meta name="twitter:description" content="${description}">`,
|
||||
`<meta property="og:image" content="${image}">`,
|
||||
`<meta property="og:image:alt" content="${imageAlt}">`,
|
||||
`<meta name="twitter:image" content="${image}">`,
|
||||
`<meta name="twitter:image:alt" content="${imageAlt}">`,
|
||||
].join("\n");
|
||||
const replaceableTags =
|
||||
/<title\b[^>]*>[\s\S]*?<\/title>|<meta\b[^>]*(?:name|property)=["'](?:description|og:(?:title|description|url|image|image:alt|type|site_name)|twitter:(?:card|title|description|image|image:alt)|article:section)["'][^>]*>|<link\b[^>]*rel=["']canonical["'][^>]*>/gi;
|
||||
|
||||
return html.replace(replaceableTags, "").replace("<head>", `<head>\n${tags}`);
|
||||
};
|
||||
|
||||
const emailTemplate = (filename) => {
|
||||
const hooksPath = $os.getenv("WORKSHOP_PB_HOOKS_DIR") || __hooks;
|
||||
return $os.readFile($filepath.join(hooksPath, filename));
|
||||
@@ -32,5 +63,6 @@ module.exports = {
|
||||
emailTemplate,
|
||||
escapeHtml,
|
||||
rejectRequest,
|
||||
renderWorkshopSocialHtml,
|
||||
sendEmail,
|
||||
};
|
||||
@@ -17,6 +17,46 @@ onBootstrap((event) => {
|
||||
console.log(JSON.stringify({ event: "workshop_oauth_synchronized", enabled: configured }));
|
||||
});
|
||||
|
||||
const workshopDetailPage = (event) => {
|
||||
const id = event.request.pathValue("id");
|
||||
if (id === "admin") return event.fileFS($os.dirFS("/pb_public"), "workshop/admin/index.html");
|
||||
|
||||
const indexHtml = toString($os.readFile("/pb_public/index.html"));
|
||||
try {
|
||||
const { renderWorkshopSocialHtml } = require(`${__hooks}/workshop-utils.js`);
|
||||
const submission = event.app.findRecordById("submissions", id);
|
||||
const type = submission.getString("type");
|
||||
const section = type === "customCss" ? "Custom CSS" : "Custom widget";
|
||||
const submissionTitle = submission.getString("title");
|
||||
const title = `${submissionTitle} · Homarr Workshop`;
|
||||
const description = `${section} for Homarr. ${submission.getString("description")}`.trim();
|
||||
const workshopUrl = $os.getenv("WORKSHOP_WEB_URL").replace(/\/$/, "");
|
||||
const apiUrl = $os.getenv("WORKSHOP_API_URL").replace(/\/$/, "");
|
||||
const websiteUrl = $os.getenv("HOMARR_WEBSITE_URL").replace(/\/$/, "");
|
||||
const screenshot = submission.getStringSlice("screenshots")[0];
|
||||
const image = screenshot
|
||||
? `${apiUrl}/api/files/submissions/${submission.id}/${encodeURIComponent(screenshot)}`
|
||||
: `${websiteUrl}/img/logo.png`;
|
||||
|
||||
return event.html(
|
||||
200,
|
||||
renderWorkshopSocialHtml(indexHtml, {
|
||||
title,
|
||||
description,
|
||||
url: `${workshopUrl}/${submission.id}`,
|
||||
image,
|
||||
section,
|
||||
submissionTitle,
|
||||
}),
|
||||
);
|
||||
} catch {
|
||||
return event.html(200, indexHtml);
|
||||
}
|
||||
};
|
||||
|
||||
routerAdd("GET", "/workshop/{id}", workshopDetailPage);
|
||||
routerAdd("GET", "/workshop/{id}/{$}", workshopDetailPage);
|
||||
|
||||
onRecordCreateRequest((event) => {
|
||||
event.record.set("revision", 1);
|
||||
event.record.set("expectedRevision", 0);
|
||||
|
||||
Reference in new issue
Block a user