erudit 3.0.0-dev.18 → 3.0.0-dev.19

package/app/pages/contributors.vue

@@ -0,0 +1,183 @@
+<script lang="ts" setup>
+import eruditConfig from '#erudit/config';
+
+const { data: contributorList } = await useFetch(`/api/contributor/list`, {
+    key: 'contributor-list',
+});
+
+const editorsNumber = computed(() => {
+    return contributorList.value?.filter((i) => i.isEditor)?.length ?? 0;
+});
+
+const phrase = await usePhrases(
+    'contributors',
+    'contributors_page_description',
+    'contributors_page_invite',
+    'contributions_explain',
+    'editor',
+);
+
+useHead({
+    title:
+        phrase.contributors +
+        ' - ' +
+        (eruditConfig.seo?.title || eruditConfig.site?.title),
+});
+
+useSeoMeta({
+    title:
+        phrase.contributors +
+        ' - ' +
+        (eruditConfig.seo?.title || eruditConfig.site?.title),
+    description: phrase.contributors_page_description,
+});
+
+const fullDescription = (() => {
+    let _description = phrase.contributors_page_description;
+
+    if (eruditConfig.content?.howToImproveLink) {
+        _description +=
+            ' ' +
+            phrase.contributors_page_invite(
+                eruditConfig.content.howToImproveLink,
+            );
+    }
+
+    return _description;
+})();
+</script>
+
+<template>
+    <MainTitle icon="users" :title="phrase.contributors" />
+    <MainDescription
+        :class="$style.pageDescription"
+        :html="true"
+        :description="fullDescription"
+    />
+    <section :class="$style.contributors">
+        <NuxtLink
+            :to="`/contributor/${contributor.contributorId}`"
+            :prefetch="false"
+            v-for="(contributor, i) of contributorList"
+            :class="$style.contributor"
+            :style="{
+                '--contributorColor': stringColor(contributor.contributorId),
+            }"
+        >
+            <ContributorAvatar
+                :contributorId="contributor.contributorId"
+                :avatar="contributor.avatar"
+                :class="$style.avatar"
+            />
+            <div :class="$style.info">
+                <div :class="$style.main">
+                    <div :class="$style.position">
+                        <template v-if="contributor.isEditor">
+                            <MyIcon
+                                :title="phrase.editor"
+                                :class="$style.editor"
+                                name="graduation"
+                            />
+                        </template>
+                        <template v-else>
+                            {{ i - editorsNumber + 1 }}.
+                        </template>
+                    </div>
+                    <div :class="$style.name">
+                        {{
+                            contributor.displayName || contributor.contributorId
+                        }}
+                    </div>
+                </div>
+                <div :class="$style.contributions">
+                    {{
+                        phrase.contributions_explain(contributor.contributions)
+                    }}
+                </div>
+            </div>
+        </NuxtLink>
+    </section>
+</template>
+
+<style lang="scss" module>
+@use '$/def/bp';
+
+.pageDescription a {
+    color: inherit;
+    text-decoration-style: dashed;
+    text-decoration-color: var(--textDimmed);
+
+    &:hover {
+        text-decoration-style: solid;
+        text-decoration-color: var(--text);
+    }
+}
+
+.contributors {
+    padding: var(--_pMainY) var(--_pMainX);
+    display: grid;
+    grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
+    gap: var(--gap);
+
+    @include bp.below('mobile') {
+        padding: var(--_pMainY) 0;
+        gap: 0;
+    }
+
+    .contributor {
+        display: flex;
+        align-items: center;
+        gap: var(--gap);
+        padding: var(--gap);
+        border-radius: 5px;
+        text-decoration: none;
+        color: inherit;
+        @include transition(background);
+
+        &:hover {
+            background: var(--bgAccent);
+        }
+
+        @include bp.below('mobile') {
+            border-radius: 0;
+        }
+
+        .avatar {
+            --_avatarSize: 50px;
+            flex-shrink: 0;
+            box-shadow: 0 0 5px 5px
+                color-mix(in srgb, var(--contributorColor), transparent 85%);
+        }
+
+        .info {
+            display: flex;
+            flex-direction: column;
+
+            .main {
+                display: flex;
+                align-items: center;
+                gap: 5px;
+
+                .position {
+                    font-size: 0.9em;
+                    font-weight: 600;
+                    color: var(--textMuted);
+
+                    .editor {
+                        cursor: help;
+                    }
+                }
+
+                .name {
+                    font-weight: 600;
+                }
+            }
+
+            .contributions {
+                color: var(--textMuted);
+                font-size: 0.85em;
+            }
+        }
+    }
+}
+</style>

package/app/pages/group/[...groupId].vue

@@ -1,22 +1,20 @@
 <script lang="ts" setup>
-import { NO_ALIASES } from '@erudit-js/cog/schema';
+import { type BitranLocation } from '@erudit-js/cog/schema';
 import eruditConfig from '#erudit/config';
 
 import { type ContentGroupData } from '@shared/content/data/type/group';
 import { locationIcon } from '@erudit/shared/icons';
-import ContentDecoration from '@app/components/main/utils/ContentDecoration.vue';
-import Breadcrumb from '@app/components/main/utils/Breadcrumb.vue';
-import ContentTitle from '@app/components/main/utils/ContentTitle.vue';
-import ContentDescription from '@app/components/main/utils/ContentDescription.vue';
-import ContentPopovers from '@app/components/main/utils/ContentPopovers.vue';
-import ContentSection from '@app/components/main/utils/ContentSection.vue';
 
-const location = useBitranLocation();
+import ContentBreadcrumb from '@app/components/main/content/ContentBreadcrumb.vue';
+import ContentDecoration from '@app/components/main/content/ContentDecoration.vue';
+import ContentPopovers from '@app/components/main/content/ContentPopovers.vue';
+import ContentSection from '@app/components/main/content/ContentSection.vue';
+
+const location = useBitranLocation() as Ref<BitranLocation>;
 
 const groupData = await useContentData<ContentGroupData>();
 await useContentPage(groupData);
 
-const content = await useBitranContent(location);
 const phrase = await usePhrases('group');
 </script>
 
@@ -26,12 +24,9 @@ const phrase = await usePhrases('group');
         :decoration="groupData.generic.decoration"
     />
 
-    <Breadcrumb
-        v-if="groupData.generic.context?.length > 1"
-        :context="groupData.generic.context"
-    />
+    <ContentBreadcrumb :context="groupData.generic.context" />
 
-    <ContentTitle
+    <MainTitle
         :title="
             groupData.generic?.title ||
             groupData.generic.contentId.split('/').pop()!
@@ -40,7 +35,7 @@ const phrase = await usePhrases('group');
         :hint="phrase.group"
     />
 
-    <ContentDescription
+    <MainDescription
         v-if="groupData.generic?.description"
         :description="groupData.generic?.description"
     />
@@ -54,10 +49,7 @@ const phrase = await usePhrases('group');
     <hr style="display: none" />
 
     <ContentSection>
-        <BitranContent
-            :content
-            :context="{ location, aliases: NO_ALIASES() }"
-        />
+        <MainBitranContent :location />
     </ContentSection>
 
     <ContentSection v-if="adsAllowed() && eruditConfig.ads?.bottom">

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

@@ -1,47 +1,46 @@
 import {
     encodeBitranLocation,
-    type BitranContext,
+    parseBitranLocation,
 } from '@erudit-js/cog/schema';
 
+import type { RawBitranContent } from '@shared/bitran/content';
+
 import { PreviewDataType, type PreviewDataBase } from '../data';
 import type { PreviewFooter } from '../footer';
 import { PreviewRequestType, type PreviewRequest } from '../request';
-import type { StringBitranContent } from '@erudit/shared/bitran/stringContent';
 
 export interface PreviewDataUnique extends PreviewDataBase {
     type: PreviewDataType.Unique;
-    productName: string;
-    bitran: {
-        context: BitranContext;
-        content: StringBitranContent;
-    };
+    elementName: string;
+    title: string;
+    rawBitranContent: RawBitranContent;
     footer: PreviewFooter;
 }
 
 export async function buildUnique(
     request: PreviewRequest,
-): Promise<PreviewDataUnique> {
+): Promise<PreviewDataUnique | undefined> {
     if (request.type !== PreviewRequestType.Link) return;
 
     const { linkTarget } = request;
 
     if (linkTarget.type !== 'unique') return;
 
-    const serverData = (await $fetch(
+    const serverData = await $fetch(
         `/api/preview/unique/${encodeBitranLocation(linkTarget._absoluteStrLocation!)}`,
         { responseType: 'json' },
-    )) as any;
-    const productName = serverData.bitran.productName;
-    const customTitle = serverData.productTitle;
+    );
+    const elementName = serverData.elementName;
+    const customTitle = serverData.title;
 
-    const icon = await useBitranElementIcon(productName);
+    const icon = await useBitranElementIcon(elementName);
 
     const productPhraseName = await (async () => {
-        const elementPhrase = await useBitranElementLanguage(productName);
+        const elementPhrase = await useBitranElementLanguage(elementName);
         try {
             return elementPhrase('_element_title');
         } catch {
-            return productName;
+            return elementName;
         }
     })();
 
@@ -53,15 +52,13 @@ export async function buildUnique(
         ? (secondary ? ' • ' : '') + productPhraseName
         : '';
 
-    const primary = customTitle || productPhraseName || productName;
+    const primary = customTitle || productPhraseName || elementName;
 
     return {
         type: PreviewDataType.Unique,
-        productName,
-        bitran: {
-            context: serverData.bitran.context,
-            content: serverData.bitran.content as any,
-        },
+        elementName: elementName,
+        title: customTitle || productPhraseName,
+        rawBitranContent: serverData.rawBitranContent as RawBitranContent,
         footer: {
             iconSvg: icon,
             primary,

package/languages/en.ts

@@ -26,7 +26,18 @@ const english: EruditPhrases = {
     theme_dark: 'Dark',
     content: 'Content',
     main_page: 'Main page',
-    members: 'Members',
+    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!`,
+    contributor: 'Contributor',
+    contribution: 'Contribution',
+    contributions_explain: (count) =>
+        `Contributed to ${m(count, 'material', 'materials')}`,
+    contributor_description: (name) =>
+        `Page with information about the contributor "${name}" and his contribution to the project.`,
+    editor: 'Editor',
     add_translation: 'Add translation',
     empty_nav: 'Empty navigation',
     flag_dev: 'Development',
@@ -57,7 +68,6 @@ const english: EruditPhrases = {
     article: 'Article',
     summary: 'Summary',
     practice: 'Practice',
-    contributor: 'Contributor',
     element_id: 'Element ID',
     preview_missing_title: 'Element not found!',
     preview_missing_explain: `Can't find the element with specified ID in this page!<br>Perhaps the element ID is specified incorrectly or the element has been changed/deleted.`,
@@ -68,7 +78,6 @@ const english: EruditPhrases = {
     current_page_hash: 'Current hash',
     expected_page_hash: 'Expected hash',
     empty_toc: 'Empty table of contents...',
-    contributors: 'Contributors',
     no_contributors: 'No contributors...',
     make_contribution: 'Make a contribution',
     material_improvement: 'Material improvement',

package/languages/ru.ts

@@ -26,7 +26,18 @@ const russian: EruditPhrases = {
     theme_dark: 'Темная',
     content: 'Контент',
     main_page: 'Главная страница',
-    members: 'Участники',
+    contributors: 'Авторы',
+    contributors_page_description:
+        'Список людей, которые внесли вклад в материалы проекта: предложили ценные идеи, вносили корректировки в существующий материал или же написали собственный!',
+    contributors_page_invite: (link) =>
+        `Вы тоже можете помочь проекту, <a href="${link}" target="_blank">внести свой вклад</a> и попасть на эту страницу!`,
+    contributor: 'Автор',
+    contribution: 'Вклад',
+    contributions_explain: (count) =>
+        `Вклад в ${m(count, 'материал', 'материала', 'материалов')}`,
+    contributor_description: (name) =>
+        `Страница с информацией о авторе "${name}" и его вкладе в проект.`,
+    editor: 'Редактор',
     add_translation: 'Добавить перевод',
     empty_nav: 'Пустая навигация',
     flag_dev: 'Разработка',
@@ -57,7 +68,6 @@ const russian: EruditPhrases = {
     article: 'Статья',
     summary: 'Конспект',
     practice: 'Задачи',
-    contributor: 'Автор',
     element_id: 'ID элемента',
     preview_missing_title: 'Элемент не найден!',
     preview_missing_explain:
@@ -69,7 +79,6 @@ const russian: EruditPhrases = {
     current_page_hash: 'Текущий хеш',
     expected_page_hash: 'Ожидаемый хеш',
     empty_toc: 'Пустая таблица содержимого...',
-    contributors: 'Авторы',
     no_contributors: 'Авторов нет...',
     make_contribution: 'Внести свой вклад',
     material_improvement: 'Улучшение материала',

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "erudit",
-    "version": "3.0.0-dev.18",
+    "version": "3.0.0-dev.19",
     "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.18",
-        "@erudit-js/cli": "3.0.0-dev.18",
-        "@erudit-js/bitran-elements": "3.0.0-dev.18"
+        "@erudit-js/cog": "3.0.0-dev.19",
+        "@erudit-js/cli": "3.0.0-dev.19",
+        "@erudit-js/bitran-elements": "3.0.0-dev.19"
     },
     "dependencies": {
         "@bitran-js/core": "1.0.0-dev.13",
@@ -31,7 +31,7 @@
         "glob": "^11.0.2",
         "image-size": "^2.0.2",
         "jiti": "^2.4.2",
-        "nuxt": "3.17.2",
+        "nuxt": "3.17.3",
         "nuxt-my-icons": "1.1.1",
         "sass": "^1.87.0",
         "sqlite3": "^5.1.7",

package/server/api/aside/minor/book/[...bookId].ts

@@ -0,0 +1,18 @@
+import {
+    getAsideMinorContentBase,
+    getAsideMinorContentNode,
+} from '@server/repository/asideMinor';
+
+import type { AsideMinorBook } from '@erudit/shared/aside/minor';
+
+export default defineEventHandler(async (event) => {
+    const bookNavNode = getAsideMinorContentNode(
+        'book',
+        event.context.params?.bookId,
+    );
+
+    return {
+        type: 'book',
+        ...(await getAsideMinorContentBase(bookNavNode)),
+    } satisfies AsideMinorBook;
+});

package/server/api/aside/minor/contributor/[contributorId].ts

@@ -0,0 +1,18 @@
+import { getContributions } from '@server/repository/contributor';
+import type { AsideMinorContributor } from '@erudit/shared/aside/minor';
+
+export default defineEventHandler(async (event) => {
+    const contributorId = event.context.params?.contributorId;
+
+    if (!contributorId) {
+        throw createError({
+            statusCode: 400,
+            message: 'Missing contributor ID!',
+        });
+    }
+
+    return {
+        type: 'contributor',
+        contributions: await getContributions(contributorId),
+    } satisfies AsideMinorContributor;
+});

package/server/api/aside/minor/group/[...groupId].ts

@@ -0,0 +1,18 @@
+import {
+    getAsideMinorContentNode,
+    getAsideMinorContentBase,
+} from '@server/repository/asideMinor';
+
+import type { AsideMinorGroup } from '@erudit/shared/aside/minor';
+
+export default defineEventHandler(async (event) => {
+    const groupNavNode = getAsideMinorContentNode(
+        'group',
+        event.context.params?.groupId,
+    );
+
+    return {
+        type: 'group',
+        ...(await getAsideMinorContentBase(groupNavNode)),
+    } satisfies AsideMinorGroup;
+});

package/server/api/aside/minor/news.ts

@@ -1,7 +1,7 @@
 import type { AsideMinorNews } from '@shared/aside/minor';
 
 export default defineEventHandler(async () => {
-    return <AsideMinorNews>{
+    return {
         type: 'news',
-    };
+    } satisfies AsideMinorNews;
 });

package/server/api/aside/minor/topic.ts

@@ -0,0 +1,36 @@
+import type { TopicPart } from '@erudit-js/cog/schema';
+
+import { getBitranToc } from '@server/bitran/toc';
+import {
+    getAsideMinorContentBase,
+    getAsideMinorContentNode,
+} from '@server/repository/asideMinor';
+import { getTopicPartsLinks } from '@server/repository/topic';
+
+import type { AsideMinorTopic } from '@erudit/shared/aside/minor';
+
+export default defineEventHandler(async (event) => {
+    const query = getQuery<{ topicId: string; topicPart: TopicPart }>(event);
+    const topicNavNode = getAsideMinorContentNode('topic', query.topicId);
+    const topicPart = query.topicPart;
+
+    if (!topicPart) {
+        throw createError({
+            statusCode: 400,
+            statusText: 'Missing "topicPart" query parameter!',
+        });
+    }
+
+    const toc = await getBitranToc({
+        type: topicPart,
+        path: topicNavNode.fullId,
+    });
+
+    return {
+        type: 'topic',
+        toc,
+        part: topicPart,
+        partLinks: await getTopicPartsLinks(topicNavNode.fullId),
+        ...(await getAsideMinorContentBase(topicNavNode)),
+    } satisfies AsideMinorTopic;
+});

package/server/api/bitran/content/[...location].ts

@@ -1,10 +1,13 @@
 import { parseClientBitranLocation } from '@server/bitran/location';
 import { getBitranContent } from '@server/bitran/content';
 
-export default defineEventHandler(async (event) => {
+import { type RawBitranContent } from '@shared/bitran/content';
+
+export default defineEventHandler<Promise<RawBitranContent>>(async (event) => {
     setResponseHeader(event, 'Content-Type', 'application/json; charset=utf-8');
     const location = await parseClientBitranLocation(
         event.context.params!.location,
     );
+
     return await getBitranContent(location);
 });

package/server/api/contributor/list.ts

@@ -0,0 +1,44 @@
+import { DbContribution } from '@server/db/entities/Contribution';
+import { DbContributor } from '@server/db/entities/Contributor';
+import { ERUDIT_SERVER } from '@server/global';
+
+import { type ContributorListItem } from '@shared/contributor';
+
+export default defineEventHandler<Promise<ContributorListItem[]>>(async () => {
+    const dbContributors = await ERUDIT_SERVER.DB.manager.find(DbContributor, {
+        select: ['contributorId', 'displayName', 'isEditor', 'avatar'],
+    });
+
+    if (dbContributors.length === 0) {
+        return [];
+    }
+
+    const contributors: ContributorListItem[] = await Promise.all(
+        dbContributors.map(async (dbContributor) => {
+            const contributions = await ERUDIT_SERVER.DB.manager.count(
+                DbContribution,
+                {
+                    where: { contributorId: dbContributor.contributorId },
+                },
+            );
+
+            return {
+                contributorId: dbContributor.contributorId,
+                displayName: dbContributor.displayName,
+                isEditor: dbContributor.isEditor,
+                avatar: dbContributor.avatar,
+                contributions,
+            };
+        }),
+    );
+
+    contributors.sort((a, b) => {
+        if (a.isEditor !== b.isEditor) {
+            return a.isEditor ? -1 : 1;
+        }
+
+        return b.contributions - a.contributions;
+    });
+
+    return contributors;
+});

package/server/api/contributor/page/[contributorId].ts

@@ -0,0 +1,14 @@
+import { getContributorPageData } from '@server/repository/contributor';
+
+export default defineEventHandler(async (event) => {
+    const contributorId = event.context.params?.contributorId;
+
+    if (!contributorId) {
+        throw createError({
+            statusCode: 400,
+            message: 'Missing contributor ID!',
+        });
+    }
+
+    return await getContributorPageData(contributorId);
+});

package/server/api/preview/unique/[...location].ts

@@ -1,25 +1,19 @@
-import {
-    stringifyBitranLocation,
-    type BitranContext,
-} from '@erudit-js/cog/schema';
+import { stringifyBitranLocation } from '@erudit-js/cog/schema';
 
 import { getLocationContext } from '@server/content/context';
 import { ERUDIT_SERVER } from '@server/global';
 import { DbUnique } from '@server/db/entities/Unique';
-import { getBitranContent } from '@server/bitran/content';
 import { parseClientBitranLocation } from '@server/bitran/location';
+import { getBitranContent } from '@server/bitran/content';
 
 import type { Context } from '@shared/content/context';
-import type { StringBitranContent } from '@erudit/shared/bitran/stringContent';
+import type { RawBitranContent } from '@shared/bitran/content';
 
 interface ReturnType {
     context: Context;
-    productTitle?: string;
-    bitran: {
-        productName: string;
-        context: BitranContext;
-        content: StringBitranContent;
-    };
+    title?: string;
+    elementName: string;
+    rawBitranContent: RawBitranContent;
 }
 
 export default defineEventHandler<Promise<ReturnType>>(async (event) => {
@@ -33,7 +27,7 @@ export default defineEventHandler<Promise<ReturnType>>(async (event) => {
 
     const dbUnique = await (async () => {
         const dbUnique = ERUDIT_SERVER.DB.manager.findOne(DbUnique, {
-            select: ['productName', 'title', 'context'],
+            select: ['title', 'productName'],
             where: { location: stringifyBitranLocation(location) },
         });
 
@@ -45,17 +39,10 @@ export default defineEventHandler<Promise<ReturnType>>(async (event) => {
         return dbUnique as any as DbUnique;
     })();
 
-    const bitran = await (async () => {
-        return {
-            content: await getBitranContent(location),
-            context: dbUnique.context,
-            productName: dbUnique.productName,
-        };
-    })();
-
     return <ReturnType>{
         context,
-        productTitle: dbUnique.title,
-        bitran,
+        title: dbUnique.title,
+        elementName: dbUnique.productName,
+        rawBitranContent: await getBitranContent(location),
     };
 });