erudit 3.0.0-dev.21 → 3.0.0-dev.23

package/app/pages/index.vue

@@ -1,14 +1,29 @@
 <script lang="ts" setup>
 import eruditConfig from '#erudit/config';
+import { type IndexData } from '@shared/indexData';
+import { normalizeText } from '@erudit/utils/normalize';
 
-const phrase = await usePhrases('seo_index_title', 'seo_index_description');
+const pretty = useFormatText();
 
-const seoTitle =
+const phrase = await usePhrases(
+    'seo_index_title',
+    'seo_index_description',
+    'topics',
+    'x_contributors',
+    'x_sponsors',
+);
+
+const seoTitle = pretty(
     eruditConfig.seo?.indexTitle ||
-    eruditConfig.seo?.title ||
-    phrase.seo_index_title;
-const seoDescription =
-    eruditConfig.seo?.indexDescription || phrase.seo_index_description;
+        eruditConfig.seo?.title ||
+        phrase.seo_index_title,
+);
+
+const seoDescription = pretty(
+    normalizeText(
+        eruditConfig.seo?.indexDescription || phrase.seo_index_description,
+    ),
+);
 
 useSeoMeta({
     title: seoTitle,
@@ -16,17 +31,175 @@ useSeoMeta({
     description: seoDescription,
     ogDescription: seoDescription,
 });
+
+const { data: indexData } = (await useAsyncData('index', () =>
+    $fetch('/api/index/data'),
+)) as { data: Ref<IndexData> };
+
+const logotype = computed(() => {
+    return eruditConfig.index?.logotype
+        ? {
+              src: eruditConfig.index.logotype.src,
+              maxWidth: eruditConfig.index.logotype.maxWidth || '100%',
+              invert: eruditConfig.index.logotype.invert,
+          }
+        : undefined;
+});
+
+const title = computed(() => {
+    return pretty(
+        eruditConfig.index?.title ||
+            eruditConfig.seo?.title ||
+            eruditConfig.site?.title ||
+            phrase.seo_index_title,
+    );
+});
+
+const slogan = computed(() => {
+    return eruditConfig.index?.slogan;
+});
+
+const canShowStats = computed(() => {
+    const hasElementStats =
+        indexData.value.elementStats && indexData.value.elementStats.length > 0;
+
+    const hasTopics =
+        indexData.value.topicCount && indexData.value.topicCount > 0;
+
+    return hasElementStats || hasTopics;
+});
+
+const description = computed(() => {
+    return eruditConfig.index?.description;
+});
+
+const canShowParticipants = computed(() => {
+    return (
+        indexData.value.contributors.length > 0 ||
+        indexData.value.sponsors.length > 0
+    );
+});
 </script>
 
 <template>
-    <div style="padding: var(--_pMainY) var(--_pMainX)">
-        <h1>
-            {{
-                eruditConfig.seo?.title ||
-                eruditConfig.site?.title ||
-                phrase.seo_index_title
-            }}
-        </h1>
-        <p>TODO</p>
-    </div>
+    <header :class="$style.indexHeader">
+        <img
+            v-if="logotype"
+            :src="logotype.src"
+            :style="{ maxWidth: logotype.maxWidth }"
+            :class="[
+                $style.logotype,
+                logotype.invert === 'dark' ? $style.invertDark : '',
+                logotype.invert === 'light' ? $style.invertLight : '',
+            ]"
+        />
+        <h1 :class="$style.title">{{ pretty(title) }}</h1>
+        <section v-if="slogan" :class="$style.slogan">
+            {{ pretty(slogan) }}
+        </section>
+        <Stats
+            v-if="canShowStats"
+            :stats="[
+                {
+                    type: 'custom',
+                    icon: 'files',
+                    label: phrase.topics,
+                    count: indexData.topicCount,
+                },
+                ...indexData.elementStats,
+            ]"
+            :class="$style.stats"
+        />
+        <section v-if="description" :class="$style.description">
+            {{ pretty(description) }}
+        </section>
+        <section v-if="canShowParticipants" :class="$style.participants">
+            <IndexAvatars
+                v-if="indexData.contributors.length > 0"
+                :label="phrase.x_contributors(indexData.contributors.length)"
+                link="/contributors/"
+                :max="4"
+                icon="user"
+                :namesAvatars="indexData.contributors"
+            />
+
+            <IndexAvatars
+                v-if="indexData.sponsors.length > 0"
+                :label="phrase.x_sponsors(indexData.sponsors.length)"
+                link="/sponsors/"
+                :max="4"
+                icon="diamond"
+                :namesAvatars="indexData.sponsors"
+            />
+        </section>
+    </header>
+    <MainToc v-if="indexData.contentToc" :toc="indexData.contentToc" />
 </template>
+
+<style lang="scss" module>
+@use '$/def/bp';
+
+.indexHeader {
+    display: flex;
+    flex-direction: column;
+    gap: calc(1.5 * var(--_pMainY));
+    //padding: var(--_pMainY) 5.5vw;
+    padding: var(--_pMainY) var(--_pMainX);
+
+    @include bp.below('mobile') {
+        padding: var(--_pMainY) var(--_pMainX);
+    }
+
+    .logotype {
+        margin: 0 auto;
+        margin-bottom: var(--_pMainY);
+        width: 100%;
+
+        [data-theme='dark'] &.invertDark,
+        [data-theme='light'] &.invertLight {
+            filter: invert(1) hue-rotate(180deg);
+        }
+    }
+
+    .title {
+        font-size: clamp(2em, 2vw + 1em, 2.6em);
+        text-align: center;
+        text-shadow: 3px 3px color-mix(in srgb, var(--brand), transparent 70%);
+        line-height: 1;
+    }
+
+    .slogan {
+        text-align: center;
+        font-weight: 600;
+        font-size: 1.4em;
+        color: var(--textMuted);
+    }
+
+    .stats {
+        font-size: 1.4em;
+        gap: var(--gapBig);
+        justify-content: center;
+
+        @include bp.below('mobile') {
+            gap: var(--gap);
+        }
+    }
+
+    .description {
+        font-size: 1.1em;
+        //text-align: justify;
+    }
+
+    .participants {
+        display: flex;
+        flex-wrap: wrap;
+        justify-content: space-around;
+        align-items: center;
+        gap: var(--gapBig);
+
+        @include bp.below('mobile') {
+            gap: var(--gap);
+        }
+    }
+}
+</style>

package/app/pages/sponsors.vue

@@ -23,10 +23,10 @@ useEruditHead({
     <MainTitle icon="diamond" :title="phrase.sponsors" />
     <MainDescription :description="phrase.sponsors_description" />
     <MainActionButton
-        v-if="eruditConfig.content?.howToImproveLink"
+        v-if="eruditConfig.sponsors?.addLink"
         icon="diamond"
         :label="phrase.become_sponsor"
-        :link="eruditConfig.content.howToImproveLink"
+        :link="eruditConfig.sponsors?.addLink"
     />
     <MainSection :class="$style.sponsorSection" v-if="sponsors?.tier2?.length">
         <template v-slot:header>

package/app/scripts/preview/data/pageLink.ts

@@ -1,3 +1,5 @@
+import { trailingSlash } from '@erudit/utils/url';
+
 import { PreviewDataType, type PreviewDataBase } from '../data';
 import { PreviewRequestType, type PreviewRequest } from '../request';
 import type { PreviewFooter } from '../footer';
@@ -17,7 +19,6 @@ export async function buildPageLink(
 
     if (linkTarget.type !== 'page') return;
 
-    return await $fetch(`/api/preview/page${linkTarget._href}`, {
-        responseType: 'json',
-    });
+    const route = trailingSlash(`/api/preview/page${linkTarget._href}`, false);
+    return await $fetch(route, { responseType: 'json' });
 }

package/app/scripts/preview/data/unique.ts

@@ -1,8 +1,6 @@
-import {
-    encodeBitranLocation,
-    parseBitranLocation,
-} from '@erudit-js/cog/schema';
+import { encodeBitranLocation } from '@erudit-js/cog/schema';
 
+import { trailingSlash } from '@erudit/utils/url';
 import type { RawBitranContent } from '@shared/bitran/content';
 
 import { PreviewDataType, type PreviewDataBase } from '../data';
@@ -26,10 +24,12 @@ export async function buildUnique(
 
     if (linkTarget.type !== 'unique') return;
 
-    const serverData = await $fetch(
+    const route = trailingSlash(
         `/api/preview/unique/${encodeBitranLocation(linkTarget._absoluteStrLocation!)}`,
-        { responseType: 'json' },
+        false,
     );
+
+    const serverData = (await $fetch(route, { responseType: 'json' })) as any;
     const elementName = serverData.elementName;
     const customTitle = serverData.title;
 

package/languages/en.ts

@@ -63,9 +63,10 @@ const english: EruditPhrases = {
     external_link_warn: 'You are going to visit external resource!',
     internal_link: 'Internal link',
     internal_link_warn: 'You are going to visit internal site page!',
-    book: 'Book',
+    book: 'Textbook',
     group: 'Group',
     topic: 'Topic',
+    topics: 'Topics',
     article: 'Article',
     summary: 'Summary',
     practice: 'Practice',
@@ -93,6 +94,11 @@ const english: EruditPhrases = {
     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',
+    toc: 'Table of contents',
+    mentions: (count) => m(count, 'mention', 'mentions'),
+    start_learning: 'Start learning!',
+    x_contributors: (count) => m(count, 'Contributor', 'Contributors'),
+    x_sponsors: (count) => m(count, 'Sponsor', 'Sponsors'),
 };
 
 export default english;

package/languages/ru.ts

@@ -46,7 +46,7 @@ const russian: EruditPhrases = {
         'Этот материал в разработке! Он может измениться в будущем и даже содержать ошибки!',
     flag_advanced: 'Профиль',
     flag_advanced_description:
-        'Этот материал предназначен для учеников с высоким уровнем понимания предмета. Информация здесь не предназначена для новичокв!',
+        'Этот материал предназначен для учеников с высоким уровнем понимания предмета. Информация здесь не предназначена для новичков!',
     flag_secondary: 'Дополнение',
     flag_secondary_description:
         'Это дополнительный материал для тех, кто хочет глубже погрузиться предмет и получить дополнительные знания и контекст.',
@@ -63,9 +63,10 @@ const russian: EruditPhrases = {
     external_link_warn: 'Вы собираетесь перейти на внешний ресурс!',
     internal_link: 'Внутренняя ссылка',
     internal_link_warn: 'Вы собираетесь перейти на внутреннюю страницу сайта!',
-    book: 'Книга',
+    book: 'Учебник',
     group: 'Группа',
     topic: 'Тема',
+    topics: 'Темы',
     article: 'Статья',
     summary: 'Конспект',
     practice: 'Задачи',
@@ -94,6 +95,12 @@ const russian: EruditPhrases = {
     sponsors_description:
         'Список людей и организаций, которые поддерживают проект финансово. Благодаря им проект может существовать и развиваться. Если вы хотите помочь проекту, то тоже можете стать спонсором и попасть на эту страницу!',
     become_sponsor: 'Стать спонсором',
+    toc: 'Содержание',
+    mentions: (count: number) =>
+        m(count, 'упоминание', 'упоминания', 'упоминаний'),
+    start_learning: 'Начать изучение!',
+    x_contributors: (count: number) => m(count, 'Автор', 'Автора', 'Авторов'),
+    x_sponsors: (count: number) => m(count, 'Спонсор', 'Спонсора', 'Спонсоров'),
 };
 
 export default russian;
@@ -107,6 +114,6 @@ export function m(
 ) {
     const text = [five, one, two, two, two, five][
         number % 100 > 10 && number % 100 < 20 ? 0 : Math.min(number % 10, 5)
-    ];
+    ]!;
     return includeNumber ? `${number} ${text}` : text;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "erudit",
-    "version": "3.0.0-dev.21",
+    "version": "3.0.0-dev.23",
     "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.21",
-        "@erudit-js/cli": "3.0.0-dev.21",
-        "@erudit-js/bitran-elements": "3.0.0-dev.21"
+        "@erudit-js/cog": "3.0.0-dev.23",
+        "@erudit-js/cli": "3.0.0-dev.23",
+        "@erudit-js/bitran-elements": "3.0.0-dev.23"
     },
     "dependencies": {
         "@bitran-js/core": "1.0.0-dev.13",

package/server/api/content/data.ts

@@ -1,16 +1,23 @@
+import type { ContentGeneric } from '@shared/content/data/base';
+import type { ContentTopicData } from '@shared/content/data/type/topic';
+import type { ContentGroupData } from '@shared/content/data/type/group';
+import type { ContentBookData } from '@shared/content/data/type/book';
+import type { ContentGroupLike } from '@shared/content/data/groupLike';
+
 import { getTopicPartsLinks } from '@server/repository/topic';
 import { getContentBookFor } from '@server/repository/book';
 import { getContentGenericData } from '@server/repository/content';
 import { getFullContentId } from '@server/repository/contentId';
-
-import type { ContentGenericData } from '@shared/content/data/base';
-import type { ContentTopicData } from '@shared/content/data/type/topic';
-import type { ContentGroupData } from '@shared/content/data/type/group';
-import type { ContentBookData } from '@shared/content/data/type/book';
+import { getQuickLinks } from '@server/repository/quickLink';
+import { getContentToc } from '@server/repository/contentToc';
+import { getContentSourceUsageSet } from '@server/repository/reference';
+import { getReadLink } from '@server/repository/readLink';
+import { getElementStats } from '@server/repository/elementStats';
+import { countTopicsIn } from '@server/repository/topicCount';
 
 export default defineEventHandler(async (event) => {
     let contentId = getQuery(event)?.contentId as string;
-    contentId = await getFullContentId(contentId);
+    contentId = getFullContentId(contentId);
 
     if (!contentId) {
         throw createError({
@@ -41,7 +48,7 @@ export default defineEventHandler(async (event) => {
 //
 
 async function getTopicData(
-    generic: ContentGenericData,
+    generic: ContentGeneric,
 ): Promise<ContentTopicData> {
     const contentBook = await getContentBookFor(generic.contentId);
 
@@ -50,26 +57,41 @@ async function getTopicData(
         generic,
         bookTitle: contentBook?.title,
         topicPartLinks: await getTopicPartsLinks(generic.contentId),
+        quickLinks: await getQuickLinks(generic.contentId),
     };
 }
 
 async function getGroupData(
-    generic: ContentGenericData,
+    generic: ContentGeneric,
 ): Promise<ContentGroupData> {
     const contentBook = await getContentBookFor(generic.contentId);
 
     return {
         type: 'group',
         generic,
+        groupLike: await getGroupLikeData(generic.contentId),
         bookTitle: contentBook?.title,
     };
 }
 
-async function getBookData(
-    generic: ContentGenericData,
-): Promise<ContentBookData> {
+async function getBookData(generic: ContentGeneric): Promise<ContentBookData> {
     return {
         type: 'book',
         generic,
+        groupLike: await getGroupLikeData(generic.contentId),
+    };
+}
+
+//
+//
+//
+
+async function getGroupLikeData(contentId: string): Promise<ContentGroupLike> {
+    return {
+        contentToc: await getContentToc(contentId),
+        readLink: await getReadLink(contentId),
+        topicCount: await countTopicsIn(contentId),
+        elementStats: await getElementStats(contentId),
+        sourceUsageSet: await getContentSourceUsageSet(contentId),
     };
 }

package/server/api/index/data.ts

@@ -0,0 +1,46 @@
+import type { IndexData } from '@shared/indexData';
+
+import { getAllElementStats } from '@server/repository/elementStats';
+import { countAllTopics } from '@server/repository/topicCount';
+import { getFullContentToc } from '@server/repository/contentToc';
+import { ERUDIT_SERVER } from '@server/global';
+import { DbContributor } from '@server/db/entities/Contributor';
+import { getSponsorIds, readSponsorConfig } from '@server/sponsor/repository';
+
+export default defineEventHandler<Promise<IndexData>>(async () => {
+    return {
+        elementStats: await getAllElementStats(),
+        topicCount: await countAllTopics(),
+        contentToc: await getFullContentToc(),
+        contributors: await getIndexContributors(),
+        sponsors: await getIndexSponsors(),
+    };
+});
+
+async function getIndexContributors(): Promise<[string, string | undefined][]> {
+    const dbContributors = await ERUDIT_SERVER.DB.manager.find(DbContributor, {
+        select: ['contributorId', 'displayName', 'avatar'],
+    });
+
+    return dbContributors.map((contributor) => [
+        contributor.displayName || contributor.contributorId,
+        contributor.avatar ? '/contributors/' + contributor.avatar : undefined,
+    ]);
+}
+
+async function getIndexSponsors(): Promise<[string, string | undefined][]> {
+    const sponsorIds = getSponsorIds();
+    const indexSponsors: [string, string | undefined][] = [];
+
+    for (const sponsorId of sponsorIds) {
+        const config = await readSponsorConfig(sponsorId);
+        if (config) {
+            indexSponsors.push([
+                config.name || sponsorId,
+                ERUDIT_SERVER.SPONSORS?.avatars[sponsorId],
+            ]);
+        }
+    }
+
+    return indexSponsors;
+}

package/server/plugin/bitran/content.ts

@@ -95,20 +95,6 @@ async function retrieveContentFrom(location: BitranLocation) {
         };
     }
 
-    if (location.type === 'group') {
-        const dbGroup = await ERUDIT_SERVER.DB.manager.findOne(DbGroup, {
-            select: ['contentId', 'content'],
-            where: { contentId: location.path },
-        });
-
-        if (!dbGroup) throwNotFound();
-
-        return {
-            biCode: dbGroup!.content!,
-            context: { location, aliases: NO_ALIASES() },
-        };
-    }
-
     if (location.type === 'contributor') {
         const dbContributor = await ERUDIT_SERVER.DB.manager.findOne(
             DbContributor,

package/server/plugin/bitran/location.ts

@@ -1,5 +1,6 @@
 import {
     decodeBitranLocation,
+    isContentType,
     parseBitranLocation,
 } from '@erudit-js/cog/schema';
 
@@ -19,12 +20,8 @@ export async function parseClientBitranLocation(clientLocation: string) {
     try {
         const location = parseBitranLocation(clientLocation);
 
-        switch (location.type) {
-            case 'article':
-            case 'summary':
-            case 'practice':
-            case 'group':
-                location.path = getFullContentId(location.path!);
+        if (isContentType(location.type)) {
+            location.path = getFullContentId(location.path!);
         }
 
         return location;

package/server/plugin/build/jobs/content/parse.ts

@@ -11,13 +11,25 @@ import {
 import { AliasesNode } from '@erudit-js/bitran-elements/aliases/shared';
 import { DetailsNode } from '@erudit-js/bitran-elements/details/shared';
 import { HeadingNode } from '@erudit-js/bitran-elements/heading/shared';
+import {
+    problemName,
+    ProblemNode,
+    problemsName,
+    ProblemsNode,
+    type ProblemParseData,
+    type ProblemsParseData,
+} from '@erudit-js/bitran-elements/problem/shared';
 
 import { createBitranTranspiler } from '@server/bitran/transpiler';
 import { ERUDIT_SERVER } from '@server/global';
 import { DbUnique } from '@server/db/entities/Unique';
+import { DbQuickLink } from '@erudit/server/plugin/db/entities/QuickLink';
+import { logger } from '@server/logger';
+import { DbStat } from '@erudit/server/plugin/db/entities/Stat';
 
 let context: BitranContext = {} as any;
 let bitranTranspiler: BitranTranspiler;
+let stats: Record<string, number> = {};
 
 const blocksAfterHeading = 2;
 
@@ -25,9 +37,10 @@ export async function parseBitranContent(
     location: BitranLocation,
     biCode: string,
 ) {
-    // Reset Bitran context in order not to create core each time
+    // Reset
     context.location = location;
     context.aliases = NO_ALIASES();
+    stats = {};
 
     bitranTranspiler ||= await createBitranTranspiler({
         context,
@@ -43,6 +56,9 @@ export async function parseBitranContent(
             const meta = node.meta;
             const uniqueId = meta?.id;
 
+            tryUpdateStats(node.name);
+            await tryAddQuickLink(node);
+
             if (node instanceof AliasesNode) {
                 mergeAliases(context.aliases, node.parseData);
             }
@@ -68,6 +84,8 @@ export async function parseBitranContent(
         },
     });
 
+    await saveStats();
+
     for (const heading of headings) {
         let blocksAfter = 0;
         let content = await bitranTranspiler.stringifier.stringify(heading);
@@ -104,10 +122,86 @@ export async function parseBitranContent(
         dbUnique.location = createUniqueLocation(node);
         dbUnique.content =
             content || (await bitranTranspiler.stringifier.stringify(node));
+
         dbUnique.title = node.parseData?.title || node.meta?.title || null;
+
+        if (node instanceof ProblemNode || node instanceof ProblemsNode) {
+            dbUnique.title = node.parseData.info.title;
+        }
+
         dbUnique.productName = node.name;
         dbUnique.context = context;
 
         await ERUDIT_SERVER.DB.manager.save(dbUnique);
     }
 }
+
+function tryUpdateStats(elementName: string) {
+    const trackedNames = (ERUDIT_SERVER.CONFIG?.bitran?.stat ?? []).flat();
+    if (trackedNames.includes(elementName)) {
+        stats[elementName] = (stats[elementName] || 0) + 1;
+    }
+}
+
+async function saveStats() {
+    for (const [elementName, count] of Object.entries(stats)) {
+        const dbStat = new DbStat();
+        dbStat.contentId = context.location.path!;
+        dbStat.elementName = elementName;
+        dbStat.count = count;
+        await ERUDIT_SERVER.DB.manager.save(dbStat);
+    }
+}
+
+async function tryAddQuickLink(element: ElementNode) {
+    const linkProperty = element.meta?.link;
+    if (linkProperty === undefined) return;
+
+    let linkLabel: string | undefined;
+
+    const linkCandidates = [
+        linkProperty,
+        element.parseData?.title,
+        element.meta?.title,
+    ];
+
+    if (element.name === problemName || element.name === problemsName) {
+        const problemParseData = element.parseData as
+            | ProblemParseData
+            | ProblemsParseData;
+        linkCandidates.unshift(problemParseData.info.title);
+    }
+
+    for (const linkCandidate of linkCandidates) {
+        if (typeof linkCandidate === 'string') {
+            const _label = linkCandidate.trim();
+            if (_label) {
+                linkLabel = _label;
+                break;
+            }
+        }
+    }
+
+    if (!linkLabel) {
+        logger.warn(
+            `Missing quick link label for element "${element.id}" at "${context.location.path!}"!`,
+        );
+        return;
+    }
+
+    const dbQuickLink = new DbQuickLink();
+    dbQuickLink.label = linkLabel;
+    dbQuickLink.elementName = element.name;
+    dbQuickLink.elementId = element.id;
+    dbQuickLink.contentId = context.location.path!;
+    dbQuickLink.contentType = context.location.type;
+
+    try {
+        await ERUDIT_SERVER.DB.manager.insert(DbQuickLink, dbQuickLink);
+    } catch (error) {
+        logger.warn(
+            `Failed to insert quick link "${linkLabel}" for element "${element.id}" at "${context.location.path!}"!`,
+            'This is probably because the is already a quick link with same label!',
+        );
+    }
+}