erudit 4.3.0 → 4.3.1-dev.1

package/server/erudit/ogImage/templates/sitePage.ts

@@ -0,0 +1,110 @@
+import {
+  type SatoriNode,
+  DIM_COLOR,
+  svgToDataUri,
+  truncate,
+  ogTitleColor,
+  ogRootContainer,
+  ogTopRow,
+  ogDescription,
+  ogBottomSpacer,
+  ogActionButton,
+} from '../shared';
+
+export interface SitePageOgParams {
+  title: string;
+  description?: string;
+  pageIconSvg: string;
+  logotypeDataUri?: string;
+  siteName?: string;
+  brandColor: string;
+  formatText?: (text: string) => string;
+  learnButtonText?: string;
+}
+
+export function buildSitePageOgTemplate(params: SitePageOgParams): SatoriNode {
+  const titleColor = ogTitleColor(params.brandColor);
+  const fmt = params.formatText ?? ((t: string) => t);
+
+  const children: SatoriNode[] = [];
+
+  // Top row: site logo + name
+  const top = ogTopRow({
+    logotypeDataUri: params.logotypeDataUri,
+    siteName: params.siteName,
+    formatText: params.formatText,
+  });
+  if (top) children.push(top);
+
+  // Center: icon + title inline
+  const titleTruncated = truncate(params.title, 60);
+  children.push({
+    type: 'div',
+    props: {
+      style: {
+        display: 'flex',
+        flexDirection: 'column' as const,
+        justifyContent: 'center',
+        flex: 1,
+        paddingLeft: 60,
+        paddingRight: 60,
+      },
+      children: [
+        {
+          type: 'div',
+          props: {
+            style: {
+              display: 'flex',
+              alignItems: 'center',
+              gap: 24,
+            },
+            children: [
+              {
+                type: 'img',
+                props: {
+                  src: svgToDataUri(params.pageIconSvg, DIM_COLOR),
+                  width: 44,
+                  height: 44,
+                },
+              },
+              {
+                type: 'div',
+                props: {
+                  style: {
+                    fontSize: 52,
+                    fontWeight: 700,
+                    color: titleColor,
+                    textAlign: 'left' as const,
+                    lineHeight: 1.25,
+                    maxHeight: 200,
+                    overflow: 'hidden',
+                    wordBreak: 'break-word' as const,
+                  },
+                  children: fmt(titleTruncated),
+                },
+              },
+            ],
+          },
+        },
+        // Action button
+        ...(params.learnButtonText
+          ? [ogActionButton(params.brandColor, params.learnButtonText)]
+          : []),
+      ],
+    },
+  });
+
+  // Bottom: description or spacer
+  if (params.description) {
+    children.push(
+      ogDescription({
+        description: params.description,
+        formatText: params.formatText,
+      }),
+    );
+  } else {
+    children.push(ogBottomSpacer());
+  }
+
+  return ogRootContainer(params.brandColor, children);
+}

package/server/erudit/staticFile.ts

@@ -7,6 +7,9 @@ const mimeByExt: Record<string, string> = {
   '.jpeg': 'image/jpeg',
   '.gif': 'image/gif',
   '.webp': 'image/webp',
+  '.mp4': 'video/mp4',
+  '.webm': 'video/webm',
+  '.ogg': 'video/ogg',
   '.txt': 'text/plain; charset=utf-8',
   '.json': 'application/json; charset=utf-8',
   '.html': 'text/html; charset=utf-8',

package/server/routes/og/content/[...contentTypePath].ts

@@ -0,0 +1,126 @@
+import { readFileSync, existsSync } from 'node:fs';
+import { getIconSvg } from '#layers/erudit/server/erudit/ogImage/icons';
+import { renderOgImage } from '#layers/erudit/server/erudit/ogImage/render';
+import {
+  type ContentOgParams,
+  buildContentOgTemplate,
+} from '#layers/erudit/server/erudit/ogImage/templates/content';
+import { loadLogotypeDataUri } from '#layers/erudit/server/erudit/ogImage/logotype';
+import { ogFormatText } from '#layers/erudit/server/erudit/ogImage/formatText';
+import {
+  checkOgEnabled,
+  getOgBrandColor,
+  getOgSiteName,
+  getOgLearnPhrase,
+  getOgLogotypePath,
+  sendOgPng,
+} from '#layers/erudit/server/erudit/ogImage/shared';
+import { parseContentTypePath } from '#layers/erudit/shared/utils/contentTypePath';
+
+export default defineEventHandler(async (event) => {
+  checkOgEnabled();
+
+  const rawPath = event.context.params?.contentTypePath;
+  if (!rawPath) {
+    throw createError({
+      statusCode: 400,
+      statusMessage: 'Missing content type path',
+    });
+  }
+
+  if (!rawPath.endsWith('.png')) {
+    throw createError({
+      statusCode: 400,
+      statusMessage: 'OG image path must end with .png',
+    });
+  }
+
+  const parsed = parseContentTypePath(rawPath.slice(0, -4));
+  const typeOrPart = parsed.type === 'topic' ? parsed.topicPart : parsed.type;
+  const contentId = parsed.contentId;
+
+  // Resolve content from nav tree
+  const navNode = ERUDIT.contentNav.getNodeOrThrow(contentId);
+  const fullId = navNode.fullId;
+
+  // Gather data
+  const title = await ERUDIT.repository.content.title(fullId);
+  const description = await ERUDIT.repository.content.description(fullId);
+
+  const bookNode = ERUDIT.contentNav.getBookFor(fullId);
+  const isBook = navNode.type === 'book';
+  const bookTitle = bookNode
+    ? await ERUDIT.repository.content.title(bookNode.fullId)
+    : undefined;
+
+  const brandColor = getOgBrandColor();
+  const siteName = getOgSiteName();
+
+  // Content type icon and label
+  const contentIconSvg = getIconSvg(typeOrPart);
+
+  const phrases = ERUDIT.language.phrases;
+  const contentLabel =
+    typeOrPart === 'book'
+      ? phrases.book
+      : typeOrPart === 'group'
+        ? phrases.group
+        : typeOrPart === 'page'
+          ? phrases.page
+          : typeOrPart === 'article'
+            ? phrases.article
+            : typeOrPart === 'summary'
+              ? phrases.summary
+              : typeOrPart === 'practice'
+                ? phrases.practice
+                : phrases.content;
+
+  // Book icon (for book row above title)
+  const bookIconSvg = bookTitle ? getIconSvg('book') : undefined;
+
+  // Decoration image
+  let decorationDataUri: string | undefined;
+  const decorationPath = await ERUDIT.repository.content.decoration(fullId);
+  if (decorationPath) {
+    const fullDecorationPath = ERUDIT.paths.project(decorationPath);
+    if (existsSync(fullDecorationPath)) {
+      const decorationBuffer = readFileSync(fullDecorationPath);
+      const ext = decorationPath.split('.').pop()?.toLowerCase();
+      const mime =
+        ext === 'svg'
+          ? 'image/svg+xml'
+          : ext === 'png'
+            ? 'image/png'
+            : ext === 'jpg' || ext === 'jpeg'
+              ? 'image/jpeg'
+              : ext === 'webp'
+                ? 'image/webp'
+                : 'image/png';
+      decorationDataUri = `data:${mime};base64,${decorationBuffer.toString('base64')}`;
+    }
+  }
+
+  const logotypeDataUri = await loadLogotypeDataUri(getOgLogotypePath());
+
+  const params: ContentOgParams = {
+    title,
+    description,
+    contentLabel,
+    contentIconSvg,
+    bookTitle,
+    bookIconSvg,
+    isBook,
+    decorationDataUri,
+    logotypeDataUri,
+    siteName,
+    brandColor,
+    formatText: ogFormatText,
+    learnButtonText: getOgLearnPhrase(),
+  };
+
+  const template = buildContentOgTemplate(params);
+  const cacheKey = `content_${typeOrPart}/${fullId}`;
+  const png = await renderOgImage(cacheKey, template);
+
+  return sendOgPng(event, png);
+});

package/server/routes/og/site/contributor/[contributorId].ts

@@ -0,0 +1,60 @@
+import { renderOgImage } from '#layers/erudit/server/erudit/ogImage/render';
+import {
+  type SitePageOgParams,
+  buildSitePageOgTemplate,
+} from '#layers/erudit/server/erudit/ogImage/templates/sitePage';
+import { loadLogotypeDataUri } from '#layers/erudit/server/erudit/ogImage/logotype';
+import { getIconSvg } from '#layers/erudit/server/erudit/ogImage/icons';
+import { ogFormatText } from '#layers/erudit/server/erudit/ogImage/formatText';
+import {
+  checkOgEnabled,
+  getOgBrandColor,
+  getOgSiteName,
+  getOgOpenPhrase,
+  getOgLogotypePath,
+  sendOgPng,
+} from '#layers/erudit/server/erudit/ogImage/shared';
+
+export default defineEventHandler(async (event) => {
+  checkOgEnabled();
+
+  const rawId = event.context.params?.contributorId;
+  if (!rawId) {
+    throw createError({
+      statusCode: 400,
+      statusMessage: 'Missing contributor ID',
+    });
+  }
+
+  // Strip .png suffix if Nitro passes it as part of the param
+  const contributorId = rawId.replace(/\.png$/, '');
+
+  const phrases = ERUDIT.language.phrases;
+
+  const contributor = await $fetch<{
+    id: string;
+    displayName?: string;
+    short?: string;
+  }>(`/api/contributor/page/${contributorId}`);
+
+  const displayName = contributor.displayName || contributor.id;
+
+  const params: SitePageOgParams = {
+    title: displayName,
+    description: phrases.contributor_page_description(displayName),
+    pageIconSvg: getIconSvg('contributor'),
+    logotypeDataUri: await loadLogotypeDataUri(getOgLogotypePath()),
+    siteName: getOgSiteName(),
+    brandColor: getOgBrandColor(),
+    formatText: ogFormatText,
+    learnButtonText: getOgOpenPhrase(),
+  };
+
+  const template = buildSitePageOgTemplate(params);
+  const png = await renderOgImage(
+    `__site_contributor_${contributorId}`,
+    template,
+  );
+
+  return sendOgPng(event, png);
+});

package/server/routes/og/site/contributors.png.ts

@@ -0,0 +1,38 @@
+import { renderOgImage } from '#layers/erudit/server/erudit/ogImage/render';
+import {
+  type SitePageOgParams,
+  buildSitePageOgTemplate,
+} from '#layers/erudit/server/erudit/ogImage/templates/sitePage';
+import { loadLogotypeDataUri } from '#layers/erudit/server/erudit/ogImage/logotype';
+import { getIconSvg } from '#layers/erudit/server/erudit/ogImage/icons';
+import { ogFormatText } from '#layers/erudit/server/erudit/ogImage/formatText';
+import {
+  checkOgEnabled,
+  getOgBrandColor,
+  getOgSiteName,
+  getOgOpenPhrase,
+  getOgLogotypePath,
+  sendOgPng,
+} from '#layers/erudit/server/erudit/ogImage/shared';
+
+export default defineEventHandler(async (event) => {
+  checkOgEnabled();
+
+  const phrases = ERUDIT.language.phrases;
+
+  const params: SitePageOgParams = {
+    title: phrases.contributors,
+    description: phrases.contributors_description,
+    pageIconSvg: getIconSvg('contributors'),
+    logotypeDataUri: await loadLogotypeDataUri(getOgLogotypePath()),
+    siteName: getOgSiteName(),
+    brandColor: getOgBrandColor(),
+    formatText: ogFormatText,
+    learnButtonText: getOgOpenPhrase(),
+  };
+
+  const template = buildSitePageOgTemplate(params);
+  const png = await renderOgImage('__site_contributors', template);
+
+  return sendOgPng(event, png);
+});

package/server/routes/og/site/index.png.ts

@@ -0,0 +1,51 @@
+import { renderOgImage } from '#layers/erudit/server/erudit/ogImage/render';
+import {
+  type IndexOgParams,
+  buildIndexOgTemplate,
+} from '#layers/erudit/server/erudit/ogImage/templates/index';
+import { loadLogotypeDataUri } from '#layers/erudit/server/erudit/ogImage/logotype';
+import { ogFormatText } from '#layers/erudit/server/erudit/ogImage/formatText';
+import {
+  checkOgEnabled,
+  getOgBrandColor,
+  getOgSiteName,
+  getOgSiteShort,
+  getOgLogotypePath,
+  sendOgPng,
+} from '#layers/erudit/server/erudit/ogImage/shared';
+
+export default defineEventHandler(async (event) => {
+  checkOgEnabled();
+
+  const brandColor = getOgBrandColor();
+  const siteName = getOgSiteName();
+  const logotypeDataUri = await loadLogotypeDataUri(getOgLogotypePath());
+
+  const siteShort =
+    getOgSiteShort() || ERUDIT.config.public.asideMajor?.siteInfo?.short;
+
+  let description: string | undefined;
+  try {
+    const indexPage = await $fetch<{
+      description?: string;
+      seo?: { description?: string };
+    }>('/api/indexPage');
+    description = indexPage?.seo?.description || indexPage?.description;
+  } catch {
+    // Ignore
+  }
+
+  const params: IndexOgParams = {
+    logotypeDataUri,
+    siteName,
+    short: siteShort || undefined,
+    description,
+    brandColor,
+    formatText: ogFormatText,
+  };
+
+  const template = buildIndexOgTemplate(params);
+  const png = await renderOgImage('__index', template);
+
+  return sendOgPng(event, png);
+});

package/server/routes/og/site/sponsors.png.ts

@@ -0,0 +1,38 @@
+import { renderOgImage } from '#layers/erudit/server/erudit/ogImage/render';
+import {
+  type SitePageOgParams,
+  buildSitePageOgTemplate,
+} from '#layers/erudit/server/erudit/ogImage/templates/sitePage';
+import { loadLogotypeDataUri } from '#layers/erudit/server/erudit/ogImage/logotype';
+import { getIconSvg } from '#layers/erudit/server/erudit/ogImage/icons';
+import { ogFormatText } from '#layers/erudit/server/erudit/ogImage/formatText';
+import {
+  checkOgEnabled,
+  getOgBrandColor,
+  getOgSiteName,
+  getOgOpenPhrase,
+  getOgLogotypePath,
+  sendOgPng,
+} from '#layers/erudit/server/erudit/ogImage/shared';
+
+export default defineEventHandler(async (event) => {
+  checkOgEnabled();
+
+  const phrases = ERUDIT.language.phrases;
+
+  const params: SitePageOgParams = {
+    title: phrases.sponsors,
+    description: phrases.sponsors_description,
+    pageIconSvg: getIconSvg('sponsors'),
+    logotypeDataUri: await loadLogotypeDataUri(getOgLogotypePath()),
+    siteName: getOgSiteName(),
+    brandColor: getOgBrandColor(),
+    formatText: ogFormatText,
+    learnButtonText: getOgOpenPhrase(),
+  };
+
+  const template = buildSitePageOgTemplate(params);
+  const png = await renderOgImage('__site_sponsors', template);
+
+  return sendOgPng(event, png);
+});

package/shared/utils/formatText.ts

@@ -0,0 +1,73 @@
+import type { FormatText, FormatTextState } from '@erudit-js/core/formatText';
+
+type LanguageFormatText = (text: string) => string;
+
+function enFormatter(text: string): string {
+  return text.replaceAll("'", '\u2019');
+}
+
+function ruFormatter(text: string): string {
+  return text.replace(
+    / (в|не|без|для|до|за|из|к|на|над|о|об|от|по|под|при|про|с|у|через|вокруг|около|после|перед|между|внутри|вне|из-за|из-под|ради|сквозь|среди|насчёт|вследствие|благодаря|несмотря|наперекор|вопреки|подле|возле|рядом|навстречу) /gimu,
+    ' $1\xa0',
+  );
+}
+
+const builtInFormatters: Partial<Record<string, LanguageFormatText>> = {
+  en: enFormatter,
+  ru: ruFormatter,
+};
+
+export function createFormatTextFn(
+  languageCode: string,
+  extraFormatter?: LanguageFormatText,
+): FormatText {
+  const langFormatter =
+    extraFormatter ?? builtInFormatters[languageCode] ?? ((t: string) => t);
+
+  const quoteSymbols: [string, string] =
+    languageCode === 'ru' ? ['\u00AB', '\u00BB'] : ['\u201C', '\u201D'];
+
+  function formatText(text: string, state?: FormatTextState): string;
+  function formatText(text: undefined, state?: FormatTextState): undefined;
+  function formatText(
+    text?: string,
+    state?: FormatTextState,
+  ): string | undefined;
+  function formatText(
+    text?: string,
+    state?: FormatTextState,
+  ): string | undefined {
+    if (text === undefined) {
+      return text;
+    }
+
+    // Normalize spacing
+    text = text
+      .trim()
+      .replace(/\r\n/gm, '\n')
+      .replace(/\n{3,}/gm, '\n\n')
+      .replace(/[ \t]+/gm, ' ');
+
+    // Normalize dashes
+    text = text.replace(/(^| )--($| )/gm, '$1\u2014$2');
+
+    // Normalize quotes
+    let quoteOpen = state?.quote === 'opened';
+    text = text.replaceAll(/"/gm, () => {
+      quoteOpen = !quoteOpen;
+      if (state) {
+        state.quote = quoteOpen ? 'opened' : 'closed';
+      }
+      return quoteOpen ? quoteSymbols[0] : quoteSymbols[1];
+    });
+
+    // Normalize ellipsis
+    text = text.replace(/\.{3}/gm, '\u2026');
+
+    // Language-specific formatting
+    return langFormatter(text);
+  }
+
+  return formatText;
+}

package/app/formatters/ru.ts

@@ -1,14 +0,0 @@
-export default (text: string) => {
-  text = ruStickyPrepositions(text);
-  return text;
-};
-
-/**
- * Formats prepositions in Russian text so that they are always adjacent to the next word and are not left hanging “in the air” when the line breaks.
- */
-function ruStickyPrepositions(text: string): string {
-  return text.replace(
-    / (в|не|без|для|до|за|из|к|на|над|о|об|от|по|под|при|про|с|у|через|вокруг|около|после|перед|между|внутри|вне|из-за|из-под|ради|сквозь|среди|насчёт|вследствие|благодаря|несмотря|наперекор|вопреки|подле|возле|рядом|навстречу) /gimu,
-    ' $1\xa0',
-  );
-}