erudit 3.0.0-dev.20 → 3.0.0-dev.21

package/app/plugins/prerender.server.ts

@@ -14,8 +14,20 @@ export default defineNuxtPlugin({
 
         isPrerendering = true;
 
-        const routesToPrerender = await $fetch<string[]>('/api/prerender');
-        _nuxt.runWithContext(() => prerenderRoutes(routesToPrerender));
+        const routeProviders = [
+            '/api/prerender/language',
+            '/api/prerender/cameos',
+
+            // Assets
+            '/api/prerender/assets/cameo',
+            '/api/prerender/assets/contributor',
+            '/api/prerender/assets/sponsor',
+        ];
+
+        for (const provider of routeProviders) {
+            const routes = await $fetch<string[]>(provider);
+            _nuxt.runWithContext(() => prerenderRoutes(routes));
+        }
 
         alreadyPrerendered = true;
     },

package/app/scripts/og.ts

@@ -1,5 +1,6 @@
 import eruditConfig from '#erudit/config';
 import type { ImageData } from '@erudit/shared/image';
+import { normalizeUrl } from '@erudit/utils/url';
 
 export const defaultOgImage = eruditConfig.seo?.defaultOgImage || {
     src: eruditAsset('og-default.png'),
@@ -13,7 +14,7 @@ export function createOgImageTags(siteUrl: string, data: ImageData | string) {
 
     tags.push({
         name: 'og:image',
-        content: siteUrl + (isImage ? data.src : data),
+        content: normalizeUrl(siteUrl + (isImage ? data.src : data)),
     });
 
     if (isImage) {

package/const.ts

@@ -1,4 +1,3 @@
 export const PUBLIC_ERUDIT_ASSET = '/erudit-asset/';
-export const PUBLIC_CONTRIBUTOR_ASSET = '/user-asset/contributor/';
 export const PUBLIC_CONTENT_ASSET = '/user-asset/content/';
 export const PUBLIC_USER_ASSET = '/user-asset/public/';

package/globals/cameo.ts

@@ -0,0 +1,5 @@
+import type { CameoConfig } from '@erudit-js/cog/schema';
+
+export function defineCameo(cameoConfig: CameoConfig) {
+    return cameoConfig;
+}

package/globals/register.ts

@@ -2,6 +2,9 @@ import * as erudit from './erudit';
 import * as contributor from './contributor';
 import * as bitran from './bitran';
 import * as content from './content';
+import * as cameo from './cameo';
+import * as sponsor from './sponsor';
+
 import * as asset from '@shared/asset';
 
 export function registerGlobals() {
@@ -11,6 +14,8 @@ export function registerGlobals() {
         ...bitran,
         ...content,
         ...asset,
+        ...cameo,
+        ...sponsor,
     })) {
         // @ts-ignore
         globalThis[key] = value;

package/globals/sponsor.ts

@@ -0,0 +1,17 @@
+import type {
+    SponsorConfig,
+    Tier1Sponsor,
+    Tier2Sponsor,
+} from '@erudit-js/cog/schema';
+
+export function defineTier1Sponsor(
+    sponsorConfig: SponsorConfig<Tier1Sponsor>,
+): SponsorConfig<Tier1Sponsor> {
+    return sponsorConfig;
+}
+
+export function defineTier2Sponsor(
+    sponsorConfig: SponsorConfig<Tier2Sponsor>,
+): SponsorConfig<Tier2Sponsor> {
+    return sponsorConfig;
+}

package/languages/en.ts

@@ -29,8 +29,9 @@ const english: EruditPhrases = {
     contributors: 'Contributors',
     contributors_page_description:
         'List of people who contributed to the project materials: suggested valuable ideas, made corrections to existing material or wrote their own!',
-    contributors_page_invite: (link) =>
-        `You can also help the project, <a href="${link}" target="_blank">make a contribution</a> and get on this page!`,
+    contributors_page_invite:
+        'You can also help the project, make a contribution and get on this page!',
+    become_contributor: 'Become a contributor',
     contributor: 'Contributor',
     contribution: 'Contribution',
     contributions_explain: (count) =>
@@ -87,7 +88,11 @@ const english: EruditPhrases = {
     references: 'References',
     reference_source_featured: 'Featured source',
     references_description:
-        'List of external sources that were used in writing this material. For a deeper dive into the material, it is recommended to read them in more detail, especially the featured sources, which are marked with an asterisk:',
+        'A list of external sources that were used to write this material. If there is an asterisk next to the title, it is a featured source and is worth reading if you want to delve deeper into the material.',
+    sponsors: 'Sponsors',
+    sponsors_description:
+        'People and organizations that support the project financially. Thanks to them, we can continue to develop the project and improve the quality of materials. If you want to support the project, you can become a sponsor too!',
+    become_sponsor: 'Become a sponsor',
 };
 
 export default english;

package/languages/ru.ts

@@ -29,8 +29,9 @@ const russian: EruditPhrases = {
     contributors: 'Авторы',
     contributors_page_description:
         'Список людей, которые внесли вклад в материалы проекта: предложили ценные идеи, вносили корректировки в существующий материал или же написали собственный!',
-    contributors_page_invite: (link) =>
-        `Вы тоже можете помочь проекту, <a href="${link}" target="_blank">внести свой вклад</a> и попасть на эту страницу!`,
+    contributors_page_invite:
+        'Вы тоже можете помочь проекту, внести свой вклад и попасть на эту страницу!',
+    become_contributor: 'Стать автором',
     contributor: 'Автор',
     contribution: 'Вклад',
     contributions_explain: (count) =>
@@ -88,7 +89,11 @@ const russian: EruditPhrases = {
     references: 'Источники',
     reference_source_featured: 'Избранный источник',
     references_description:
-        'Список внешних источников, которые использовались при написании этого материала. Для более глубокого погружения в материал рекомендуются ознакомиться с ними подробнее, особенно с избранными источниками, которые отмечены звездочкой:',
+        'Список внешних источников, которые использовались при написании этого материала. Если рядом с названием стоит звездочка, то это избранный источник и с ним стоит ознакомиться, если вы хотите глубже погрузиться в материал.',
+    sponsors: 'Спонсоры',
+    sponsors_description:
+        'Список людей и организаций, которые поддерживают проект финансово. Благодаря им проект может существовать и развиваться. Если вы хотите помочь проекту, то тоже можете стать спонсором и попасть на эту страницу!',
+    become_sponsor: 'Стать спонсором',
 };
 
 export default russian;

package/module/imports.ts

@@ -12,6 +12,18 @@ export function setupGlobalImports() {
             name: 'defineContributor',
             from: eruditPath('globals/contributor'),
         },
+        {
+            name: 'defineCameo',
+            from: eruditPath('globals/cameo'),
+        },
+        {
+            name: 'defineTier1Sponsor',
+            from: eruditPath('globals/sponsor'),
+        },
+        {
+            name: 'defineTier2Sponsor',
+            from: eruditPath('globals/sponsor'),
+        },
         // Bitran
         ...(() => {
             const imports = ['defineAppBitran'];
@@ -41,12 +53,7 @@ export function setupGlobalImports() {
         },
         // Helper Asset Path Functions
         ...(() => {
-            const imports = [
-                'eruditAsset',
-                'contributorAsset',
-                'contentAsset',
-                'publicAsset',
-            ];
+            const imports = ['eruditAsset', 'contentAsset', 'publicAsset'];
             return imports.map((name) => ({
                 name,
                 from: eruditPath(`shared/asset`),

package/nuxt.config.ts

@@ -1,6 +1,5 @@
 import {
     PUBLIC_CONTENT_ASSET,
-    PUBLIC_CONTRIBUTOR_ASSET,
     PUBLIC_ERUDIT_ASSET,
     PUBLIC_USER_ASSET,
 } from './const';
@@ -57,9 +56,10 @@ export default defineNuxtConfig({
             crawlLinks: true,
             failOnError: false,
             concurrency: 10,
+            routes: ['/robots.txt', '/sitemap.xml'],
             ignore: [
                 (path: string) => {
-                    const regexps = [/\?element=/gm, /#/gm, /\.json\?/gm];
+                    const regexps = [/#/gm, /\.json\?/gm];
                     const shouldIgnore = regexps.some((re) => re.test(path));
                     return shouldIgnore;
                 },
@@ -87,11 +87,6 @@ export default defineNuxtConfig({
                 dir: projectPath('content'),
                 maxAge: 60 * 60 * 24 * 30,
             },
-            {
-                baseURL: PUBLIC_CONTRIBUTOR_ASSET,
-                dir: projectPath('contributors'),
-                maxAge: 60 * 60 * 24 * 30,
-            },
         ],
         esbuild: {
             options: {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "erudit",
-    "version": "3.0.0-dev.20",
+    "version": "3.0.0-dev.21",
     "type": "module",
     "description": "🤓 CMS for perfect educational sites.",
     "license": "MIT",
@@ -15,9 +15,9 @@
         "erudit": "bin/erudit.mjs"
     },
     "peerDependencies": {
-        "@erudit-js/cog": "3.0.0-dev.20",
-        "@erudit-js/cli": "3.0.0-dev.20",
-        "@erudit-js/bitran-elements": "3.0.0-dev.20"
+        "@erudit-js/cog": "3.0.0-dev.21",
+        "@erudit-js/cli": "3.0.0-dev.21",
+        "@erudit-js/bitran-elements": "3.0.0-dev.21"
     },
     "dependencies": {
         "@bitran-js/core": "1.0.0-dev.13",

package/server/api/cameo/data/[cameoId].ts

@@ -0,0 +1,42 @@
+import { glob } from 'glob';
+import { type Cameo } from '@erudit-js/cog/schema';
+
+import { PROJECT_DIR } from '@erudit/globalPath';
+import { IMPORT } from '@server/importer';
+
+export default defineEventHandler<Promise<Cameo>>(async (event) => {
+    const cameoId = event.context.params?.cameoId;
+
+    if (typeof cameoId !== 'string' || !cameoId) {
+        throw createError({
+            statusCode: 400,
+            message: 'Cameo ID is required and must be a string!',
+        });
+    }
+
+    const avatarPaths = await glob(`cameos/${cameoId}/avatars/*`, {
+        cwd: PROJECT_DIR,
+        absolute: false,
+        posix: true,
+    });
+
+    const avatarRoutes = avatarPaths.map((path) => `/asset/${path}`);
+
+    let cameoConfig;
+    try {
+        cameoConfig = await IMPORT(`${PROJECT_DIR}/cameos/${cameoId}/cameo`, {
+            default: true,
+        });
+    } catch (error) {
+        throw createError({
+            statusCode: 500,
+            message: `Failed to import config for ID "${cameoId}"! Error: ${error}`,
+        });
+    }
+
+    return {
+        ...cameoConfig,
+        cameoId,
+        avatars: avatarRoutes,
+    } satisfies Cameo;
+});

package/server/api/cameo/ids.ts

@@ -0,0 +1,5 @@
+import { getCameoIds } from '@server/repository/cameo';
+
+export default defineEventHandler(async () => {
+    return await getCameoIds();
+});

package/server/api/prerender/assets/cameo.ts

@@ -0,0 +1,14 @@
+import { PROJECT_DIR } from '#erudit/globalPaths';
+import { glob } from 'glob';
+
+const includePatterns = [`cameos/*/avatars/*`];
+
+export default defineEventHandler(async () => {
+    const files = await glob(includePatterns, {
+        cwd: PROJECT_DIR,
+        absolute: false,
+        posix: true,
+    });
+
+    return files.map((file) => '/asset/' + file);
+});

package/server/api/prerender/assets/contributor.ts

@@ -0,0 +1,12 @@
+import { glob } from 'glob';
+import { PROJECT_DIR } from '#erudit/globalPaths';
+
+export default defineEventHandler(async () => {
+    const avatars = await glob('contributors/*/avatar.*', {
+        cwd: PROJECT_DIR,
+        absolute: false,
+        posix: true,
+    });
+
+    return avatars.map((avatar) => '/asset/' + avatar);
+});

package/server/api/prerender/assets/sponsor.ts

@@ -0,0 +1,13 @@
+import { ERUDIT_SERVER } from '@server/global';
+
+export default defineEventHandler(async () => {
+    const serverSponsors = ERUDIT_SERVER.SPONSORS;
+
+    if (!serverSponsors) {
+        return [];
+    }
+
+    return Object.values(serverSponsors.avatars)
+        .filter(Boolean)
+        .map((avatar) => '/asset/' + avatar);
+});

package/server/api/prerender/cameos.ts

@@ -0,0 +1,12 @@
+import { getCameoIds } from '@server/repository/cameo';
+import { getTier2SponsorIds } from '@server/sponsor/repository';
+
+export default defineEventHandler(async () => {
+    const cameoIds = await getCameoIds();
+    return [
+        '/api/cameo/ids',
+        '/api/sponsor/cameo/ids',
+        ...cameoIds.map((id) => `/api/cameo/data/${id}`),
+        ...getTier2SponsorIds().map((id) => `/api/sponsor/cameo/data/${id}`),
+    ];
+});

package/server/api/{prerender.ts → prerender/language.ts}

@@ -1,19 +1,9 @@
 import { ERUDIT_SERVER } from '@server/global';
 
-export default defineEventHandler(async () => {
-    const routes: string[] = [];
-    routes.push(...language());
-
-    return routes;
-});
-
-//
-//
-//
-
-function language() {
+export default defineEventHandler(() => {
     const phraseRoutes = Object.keys(ERUDIT_SERVER.LANGUAGE?.phrases || []).map(
         (phraseId) => `/api/language/phrase/${phraseId}`,
     );
+
     return ['/api/language/functions', ...phraseRoutes];
-}
+});

package/server/api/sponsor/cameo/data/[sponsorId].ts

@@ -0,0 +1,51 @@
+import { type Cameo, type Sponsor } from '@erudit-js/cog/schema';
+
+import { retrieveSponsor } from '@server/sponsor/repository';
+import { ERUDIT_SERVER } from '@server/global';
+
+export default defineEventHandler<Promise<Cameo>>(async (event) => {
+    const sponsorId = event.context.params?.sponsorId;
+
+    if (typeof sponsorId !== 'string' || !sponsorId) {
+        throw createError({
+            statusCode: 400,
+            message: 'Sponsor ID is required and must be a string!',
+        });
+    }
+
+    let sponsor: Sponsor;
+    try {
+        sponsor = await retrieveSponsor(sponsorId);
+    } catch (error) {
+        throw createError({
+            statusCode: 500,
+            message: `Failed to retrieve sponsor with ID "${sponsorId}"! Error: ${error}`,
+        });
+    }
+
+    if (sponsor.tier !== 'tier2') {
+        throw createError({
+            statusCode: 404,
+            message: `Sponsor with ID "${sponsorId}" is not a Tier 2 sponsor!`,
+        });
+    }
+
+    const defaultMessages = ERUDIT_SERVER.CONFIG.sponsors?.defaultCameoMessages;
+
+    if (!defaultMessages) {
+        throw createError({
+            statusCode: 500,
+            message: 'Default sponsor cameo messages are not configured!',
+        });
+    }
+
+    return {
+        cameoId: sponsorId,
+        name: sponsor.name,
+        icon: sponsor.icon,
+        avatars: [sponsor.avatar],
+        color: sponsor.color,
+        link: sponsor.link,
+        messages: [...(sponsor.messages || []), ...defaultMessages],
+    } satisfies Cameo;
+});

package/server/api/sponsor/cameo/ids.ts

@@ -0,0 +1,5 @@
+import { getTier2SponsorIds } from '@server/sponsor/repository';
+
+export default defineEventHandler(async () => {
+    return getTier2SponsorIds();
+});

package/server/api/sponsor/count.ts

@@ -0,0 +1,5 @@
+import { getSponsorCount } from '@server/sponsor/repository';
+
+export default defineEventHandler(async () => {
+    return getSponsorCount();
+});

package/server/api/sponsor/list.ts

@@ -0,0 +1,36 @@
+import type { Tier1Sponsor, Tier2Sponsor } from '@erudit-js/cog/schema';
+
+import { getSponsorIds, retrieveSponsor } from '@server/sponsor/repository';
+
+const BATCH_SIZE = 10;
+
+export default defineEventHandler(async () => {
+    const sponsorIds = getSponsorIds();
+    const sponsors = await processSponsorsBatched(sponsorIds);
+    return categorizeSponsorsByTier(sponsors);
+});
+
+async function processSponsorsBatched(sponsorIds: string[]) {
+    const allSponsors = [];
+
+    for (let i = 0; i < sponsorIds.length; i += BATCH_SIZE) {
+        const batch = sponsorIds.slice(i, i + BATCH_SIZE);
+        const batchResults = await Promise.all(
+            batch.map((sponsorId) => retrieveSponsor(sponsorId!)),
+        );
+        allSponsors.push(...batchResults);
+    }
+
+    return allSponsors;
+}
+
+function categorizeSponsorsByTier(sponsors: (Tier1Sponsor | Tier2Sponsor)[]) {
+    return {
+        tier1: sponsors.filter(
+            (sponsor): sponsor is Tier1Sponsor => sponsor.tier === 'tier1',
+        ),
+        tier2: sponsors.filter(
+            (sponsor): sponsor is Tier2Sponsor => sponsor.tier === 'tier2',
+        ),
+    };
+}

package/server/plugin/build/process.ts

@@ -7,6 +7,7 @@ import { setupLanguage } from './jobs/language';
 import { buildContributors } from './jobs/contributors';
 import { buildNav } from './jobs/nav';
 import { buildContent } from './jobs/content/generic';
+import { buildSponsors } from '@server/sponsor/build';
 
 let initial = true;
 
@@ -23,6 +24,7 @@ async function _build() {
     await buildContributors();
     await buildNav();
     await buildContent();
+    await buildSponsors();
 
     logger.success('Build successful!');
 }

package/server/plugin/build/rebuild.ts

@@ -13,6 +13,8 @@ const watchTargets: string[] = [
     PROJECT_DIR + '/content',
     // Contributors directory
     PROJECT_DIR + '/contributors',
+    // Sponsors directory
+    PROJECT_DIR + '/sponsors',
 ];
 
 const ignoreTargets: string[] = [];

package/server/plugin/global.ts

@@ -3,6 +3,7 @@ import type { EruditConfig } from '@erudit-js/cog/schema';
 
 import type { EruditPhrases } from '@shared/types/language';
 import type { NavNode, RootNavNode } from '@server/nav/node';
+import type { ServerSponsors } from '@server/sponsor';
 
 interface EruditServer {
     BUILD_PROMISE: Promise<void>;
@@ -11,6 +12,7 @@ interface EruditServer {
     DB: DataSource;
     NAV?: RootNavNode;
     NAV_BOOKS?: Record<string, NavNode>;
+    SPONSORS?: ServerSponsors;
 }
 
 export const ERUDIT_SERVER: EruditServer = {} as any;

package/server/plugin/repository/cameo.ts

@@ -0,0 +1,16 @@
+import { readdir } from 'node:fs/promises';
+import { PROJECT_DIR } from '#erudit/globalPaths';
+
+export async function getCameoIds() {
+    try {
+        const dirents = await readdir(`${PROJECT_DIR}/cameos`, {
+            withFileTypes: true,
+        });
+
+        return dirents
+            .filter((dirent) => dirent.isDirectory())
+            .map((dirent) => dirent.name);
+    } catch {
+        return [];
+    }
+}

package/server/plugin/repository/contributor.ts

@@ -62,13 +62,20 @@ export async function getContributions(
     );
 
     const contributions: Contribution[] = [];
+    const existingBookTitles = new Set<string>();
 
     for (const dbContribution of dbContributions) {
         const contentId = dbContribution.contentId;
         const contentNavNode = getNavNode(contentId);
 
-        const bookTitle = await (async () => {
-            const bookId = getNavBookOf(contentId)?.fullId;
+        const bookData = await (async () => {
+            const bookNavNode = getNavBookOf(contentId);
+
+            if (!bookNavNode) {
+                return undefined;
+            }
+
+            const bookId = bookNavNode.fullId;
 
             if (!bookId) {
                 return undefined;
@@ -78,14 +85,38 @@ export async function getContributions(
                 return undefined;
             }
 
-            return await getBookTitleFor(bookId);
+            let bookTitle = await getBookTitleFor(bookId);
+
+            let cursor = bookNavNode;
+            while (cursor) {
+                if (cursor.type === 'group') {
+                    const groupTitle = await getContentTitle(cursor.fullId);
+                    const newBookTitle = groupTitle + ' / ' + bookTitle;
+
+                    if (bookTitle && existingBookTitles.has(bookTitle)) {
+                        bookTitle = newBookTitle;
+                    }
+                }
+
+                cursor = cursor.parent as any;
+            }
+
+            if (bookTitle) {
+                existingBookTitles.add(bookTitle);
+            }
+
+            return {
+                bookId,
+                bookTitle,
+            };
         })();
 
         const contentTitle = await getContentTitle(contentId);
         const contentLink = await getContentLink(contentId);
 
         const contribution: Contribution = {
-            bookTitle: bookTitle,
+            bookId: bookData?.bookId,
+            bookTitle: bookData?.bookTitle,
             contentType: contentNavNode.type,
             contentTitle,
             contentLink,