erudit 3.0.0-dev.23 → 3.0.0-dev.25

package/languages/ru.ts

@@ -1,119 +0,0 @@
-const russian: EruditPhrases = {
-    _language_title: 'Русский',
-    _language_code: 'ru',
-
-    site_info_title: 'Erudit',
-    site_info_slogan: 'Современный учебник',
-    seo_index_title: 'Erudit - CMS для образовательных сайтов',
-    seo_index_description:
-        'Erudit — CMS для создания и управления идеальными образовательными сайтами, которые поддерживаются сообществом.',
-    seo_article_description: (contentTitle) =>
-        `Понятное и интересное объяснение темы «${contentTitle}». Показательные примеры, важные свойства, интересные факты, применение в жизни, понятные доказательства. Здесь вы точно разберетесь!`,
-    seo_summary_description: (contentTitle) =>
-        `Конспект темы «${contentTitle}»: ключевые определения, теоремы, свойства и примеры их использвания. Все самое важное и в кратком виде!`,
-    seo_practice_description: (contentTitle) =>
-        `Разнообразные задачи с подсказками и ответами по теме «${contentTitle}». Интересные условия, подсказки и подробные решения. Превратите знания в навык!`,
-    index: 'Оглавление',
-    pages: 'Страницы',
-    search: 'Поиск',
-    language: 'Язык',
-    other: 'Другое',
-    ads_replacer:
-        'Помогите улучшать проект.<br><strong>Включите показ рекламы!</strong>',
-    theme: 'Тема',
-    theme_system: 'Системная',
-    theme_light: 'Светлая',
-    theme_dark: 'Темная',
-    content: 'Контент',
-    main_page: 'Главная страница',
-    contributors: 'Авторы',
-    contributors_page_description:
-        'Список людей, которые внесли вклад в материалы проекта: предложили ценные идеи, вносили корректировки в существующий материал или же написали собственный!',
-    contributors_page_invite:
-        'Вы тоже можете помочь проекту, внести свой вклад и попасть на эту страницу!',
-    become_contributor: 'Стать автором',
-    contributor: 'Автор',
-    contribution: 'Вклад',
-    contributions_explain: (count) =>
-        `Вклад в ${m(count, 'материал', 'материала', 'материалов')}`,
-    contributor_description: (name) =>
-        `Страница с информацией о авторе "${name}" и его вкладе в проект.`,
-    editor: 'Редактор',
-    add_translation: 'Добавить перевод',
-    empty_nav: 'Пустая навигация',
-    flag_dev: 'Разработка',
-    flag_dev_description:
-        'Этот материал в разработке! Он может измениться в будущем и даже содержать ошибки!',
-    flag_advanced: 'Профиль',
-    flag_advanced_description:
-        'Этот материал предназначен для учеников с высоким уровнем понимания предмета. Информация здесь не предназначена для новичков!',
-    flag_secondary: 'Дополнение',
-    flag_secondary_description:
-        'Это дополнительный материал для тех, кто хочет глубже погрузиться предмет и получить дополнительные знания и контекст.',
-    popover_dependencies: 'Зависимости',
-    popover_dependencies_description:
-        'Царского пути в эту тему нет! Вы сможете разобраться только если знаете следующие темы:',
-    to_index: 'К оглавлению',
-    about_book: 'Об учебнике',
-    close: 'Закрыть',
-    back: 'Назад',
-    goto: 'Перейти',
-    error: 'Ошибка!',
-    external_link: 'Внешняя ссылка',
-    external_link_warn: 'Вы собираетесь перейти на внешний ресурс!',
-    internal_link: 'Внутренняя ссылка',
-    internal_link_warn: 'Вы собираетесь перейти на внутреннюю страницу сайта!',
-    book: 'Учебник',
-    group: 'Группа',
-    topic: 'Тема',
-    topics: 'Темы',
-    article: 'Статья',
-    summary: 'Конспект',
-    practice: 'Задачи',
-    element_id: 'ID элемента',
-    preview_missing_title: 'Элемент не найден!',
-    preview_missing_explain:
-        'Не удалось найти на этой странице элемент с указанным ID!<br>Возможно, ID элемента указан неправильно или элемент был изменен/удален.',
-    preview_missing_explain_mismatch: `Не удалось найти на этой странице элемент с указанным ID!<br>Версия страницы, на которую вела ссылка, отличается от текущей версии страницы!<br>Скорее всего, именно это и является причиной ошибки.`,
-    preview_hash_mismatch_title: 'Несовпадение версий страницы!',
-    preview_hash_mismatch_explain:
-        'Версия страницы, которую вы видите сейчас отличается от версии страницы, на которую вела исходная ссылка!<br>Содержимое может отличаться от того, что вы ожидали увидеть.',
-    current_page_hash: 'Текущий хеш',
-    expected_page_hash: 'Ожидаемый хеш',
-    empty_toc: 'Пустая таблица содержимого...',
-    no_contributors: 'Авторов нет...',
-    make_contribution: 'Внести свой вклад',
-    material_improvement: 'Улучшение материала',
-    how_to_improve: 'Как улучшить?',
-    edit_page: 'Редактировать страницу',
-    report_problem: 'Сообщить о проблеме',
-    references: 'Источники',
-    reference_source_featured: 'Избранный источник',
-    references_description:
-        'Список внешних источников, которые использовались при написании этого материала. Если рядом с названием стоит звездочка, то это избранный источник и с ним стоит ознакомиться, если вы хотите глубже погрузиться в материал.',
-    sponsors: 'Спонсоры',
-    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;
-
-export function m(
-    number: number,
-    one: string,
-    two: string,
-    five: string,
-    includeNumber = true,
-) {
-    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/module/bitran.ts

@@ -1,66 +0,0 @@
-import { globSync } from 'glob';
-import { addTemplate } from 'nuxt/kit';
-import type { Nuxt } from 'nuxt/schema';
-
-import { eruditEndNuxtPath, projectPath } from '@erudit/globalPath';
-import { logger } from '@erudit/module/logger';
-
-export async function setupBitranTemplates(_nuxt: Nuxt) {
-    const serverConfigPath = projectPath('bitran.server');
-    const appConfigPath = projectPath('bitran.app');
-
-    const hasServerConfig = globSync(serverConfigPath + '.*').length > 0;
-    const hasAppConfig = globSync(appConfigPath + '.*').length > 0;
-    const hasIncompleteBitranConfig = hasServerConfig !== hasAppConfig;
-
-    if (hasIncompleteBitranConfig) {
-        logger.warn(
-            `Failed to load Bitran. Make sure you have "bitran.server" and "bitran.app" files in your project root!`,
-        );
-    }
-
-    const serverTemplateName = '#erudit/bitran/server.ts';
-    const appTemplateName = '#erudit/bitran/app.ts';
-
-    addTemplate({
-        filename: serverTemplateName,
-        write: true,
-        getContents: () => `
-            import type { ElementTranspilers } from '@bitran-js/transpiler';
-            import { eruditTranspilers } from '@erudit-js/bitran-elements/defaultServer';
-            ${hasServerConfig ? `import getProjectTranspilers from '${serverConfigPath}';` : ''}
-
-            export default async function() {
-                const projectTranspilers = ${hasServerConfig ? 'await getProjectTranspilers()' : '{}'};
-                return {
-                    ...eruditTranspilers,
-                    ...projectTranspilers,
-                } as ElementTranspilers;
-            }
-        `,
-    });
-
-    addTemplate({
-        filename: appTemplateName,
-        write: true,
-        getContents: () => `
-            import type { EruditBitranElements } from '@erudit-js/cog/schema';
-            import { eruditElements } from '@erudit-js/bitran-elements/defaultApp';
-            ${hasAppConfig ? `import getProjectElements from '${appConfigPath}';` : ''}
-
-            export default async function() {
-                const projectElements = ${hasAppConfig ? 'await getProjectElements()' : '{}'};
-                return {
-                    ...eruditElements,
-                    ...projectElements,
-                } as EruditBitranElements;
-            }
-        `,
-    });
-
-    const alias = (_nuxt.options.alias ||= {});
-    alias['#erudit/bitran/server'] = eruditEndNuxtPath(
-        `.nuxt/${serverTemplateName}`,
-    );
-    alias['#erudit/bitran/app'] = eruditEndNuxtPath(`.nuxt/${appTemplateName}`);
-}

package/module/config.ts

@@ -1,35 +0,0 @@
-import { addTemplate } from 'nuxt/kit';
-import type { Nuxt } from 'nuxt/schema';
-import type { EruditConfig } from '@erudit-js/cog/schema';
-
-import { eruditEndNuxtPath, projectPath } from '@erudit/globalPath';
-import { logger } from '@erudit/module/logger';
-
-export async function setupEruditConfig(_nuxt: Nuxt) {
-    let config: Partial<EruditConfig> = {};
-    const configPath = projectPath('erudit.config');
-
-    try {
-        const projectConfig = (await import(configPath)).default;
-        if (!projectConfig) throw new Error('Falsy Erudit config!');
-        config = projectConfig;
-    } catch (error) {
-        logger.warn(`Failed to load Erudit config!\n\n${error}`);
-    }
-
-    const templateFilename = '#erudit/config.ts';
-
-    addTemplate({
-        filename: templateFilename,
-        write: true,
-        getContents: () => `
-            import type { EruditConfig } from '@erudit-js/cog/schema';
-            export default ${JSON.stringify(config, null, '    ')} as Partial<EruditConfig>;
-        `,
-    });
-
-    const alias = (_nuxt.options.alias ||= {});
-    alias['#erudit/config'] = eruditEndNuxtPath(`.nuxt/${templateFilename}`);
-
-    return config;
-}

package/module/imports.ts

@@ -1,74 +0,0 @@
-import { addImports, addServerImports } from 'nuxt/kit';
-
-import { eruditPath } from '@erudit/globalPath';
-
-export function setupGlobalImports() {
-    addImports([
-        {
-            name: 'defineEruditConfig',
-            from: eruditPath('globals/erudit'),
-        },
-        {
-            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'];
-            return imports.map((name) => ({
-                name,
-                from: eruditPath(`globals/bitran`),
-            }));
-        })(),
-        // Content
-        ...(() => {
-            const imports = [
-                'defineBook',
-                'defineGroup',
-                'defineTopic',
-                'defineContentReferences',
-                'defineContentSource',
-            ];
-            return imports.map((name) => ({
-                name,
-                from: eruditPath(`globals/content`),
-            }));
-        })(),
-        // Problems Generation
-        {
-            name: 'defineProblemGenerator',
-            from: '@erudit-js/bitran-elements/problem/generator',
-        },
-        // Helper Asset Path Functions
-        ...(() => {
-            const imports = ['eruditAsset', 'contentAsset', 'publicAsset'];
-            return imports.map((name) => ({
-                name,
-                from: eruditPath(`shared/asset`),
-            }));
-        })(),
-    ]);
-
-    addServerImports([
-        // Bitran
-        ...(() => {
-            const imports = ['defineServerBitran'];
-            return imports.map((name) => ({
-                name,
-                from: eruditPath(`globals/bitran`),
-            }));
-        })(),
-    ]);
-}

package/module/index.ts

@@ -1,47 +0,0 @@
-import { defineNuxtModule, updateTemplates } from 'nuxt/kit';
-
-import { registerGlobals } from '@erudit/globals/register';
-import { setupRestartWatcher } from '@erudit/module/restart';
-import { setupEruditConfig } from '@erudit/module/config';
-import { logger } from '@erudit/module/logger';
-import { setupGlobalImports } from '@erudit/module/imports';
-import { setupBitranTemplates } from './bitran';
-import { setupGlobalPaths } from './paths';
-
-export default defineNuxtModule({
-    meta: { name: 'Erudit', configKey: 'erudit' },
-    async setup(_options, _nuxt) {
-        if (_nuxt.options.dev) setupRestartWatcher(_nuxt);
-
-        setupGlobalImports();
-        registerGlobals();
-
-        const eruditConfig = await setupEruditConfig(_nuxt);
-        await setupBitranTemplates(_nuxt);
-        setupGlobalPaths(_nuxt);
-
-        if (eruditConfig.site?.baseUrl) {
-            const newBaseUrl = eruditConfig.site.baseUrl;
-            _nuxt.options.app.baseURL = newBaseUrl;
-            _nuxt.options.nitro.runtimeConfig!.app!.baseURL = newBaseUrl;
-            await updateTemplates();
-        }
-
-        {
-            const transpile = (_nuxt.options.build.transpile ||= []);
-            const optimizeDeps = _nuxt.options.vite.optimizeDeps || {};
-            const optimizeDepsInclude = (optimizeDeps.include ||= []);
-
-            const deps = eruditConfig.dependencies || {};
-            for (const [dep, options] of Object.entries(deps)) {
-                if (options?.transpile) transpile.push(dep);
-                if (options?.optimize) optimizeDepsInclude.push(dep);
-            }
-        }
-
-        // TODO: Watch for contributors folder and create/update template with their IDs
-        // TODO: Create such helpers for other features!
-
-        logger.success('Erudit module setup complete!');
-    },
-});

package/module/paths.ts

@@ -1,22 +0,0 @@
-import { addTemplate } from 'nuxt/kit';
-import type { Nuxt } from 'nuxt/schema';
-
-import { ERUDIT_DIR, eruditEndNuxtPath, PROJECT_DIR } from '@erudit/globalPath';
-
-export function setupGlobalPaths(_nuxt: Nuxt) {
-    const templateFilename = '#erudit/globalPaths.ts';
-
-    addTemplate({
-        filename: templateFilename,
-        write: true,
-        getContents: () => `
-            export const ERUDIT_DIR = '${ERUDIT_DIR}';
-            export const PROJECT_DIR = '${PROJECT_DIR}';
-        `,
-    });
-
-    const alias = (_nuxt.options.alias ||= {});
-    alias['#erudit/globalPaths'] = eruditEndNuxtPath(
-        `.nuxt/${templateFilename}`,
-    );
-}

package/module/restart.ts

@@ -1,61 +0,0 @@
-import { exit } from 'node:process';
-import { globSync } from 'glob';
-import chokidar, { type FSWatcher } from 'chokidar';
-import type { Nuxt } from 'nuxt/schema';
-
-import { eruditPath, projectPath } from '@erudit/globalPath';
-import { logger } from '@erudit/module/logger';
-import { stress } from '@erudit/utils/stress';
-
-const watchTargets: string[] = [
-    // Erudit Nuxt config file
-    eruditPath('nuxt.config.ts'),
-    // Erudit Globals
-    eruditPath('globals'),
-    // Erudit Nuxt module non-runtime files
-    ...globSync(eruditPath('module/**/*')),
-    // Erudit config in project root
-    ...globSync(projectPath('erudit.config.{js,ts}')),
-    // Erudit Bitran config in project root
-    ...globSync(projectPath('bitran.{app,server}.{js,ts}')),
-];
-
-const ignoreTargets: string[] = [
-    // Erudit Nuxt module runtime files
-    ...globSync(eruditPath('module/runtime/**/*')),
-];
-
-const restartDelay = 300;
-
-//
-//
-//
-
-let watcher: FSWatcher;
-let restartTimeout: any;
-let nuxt: Nuxt;
-
-export function setupRestartWatcher(_nuxt: Nuxt) {
-    nuxt = _nuxt;
-
-    if (watcher) return;
-
-    watcher = chokidar.watch(watchTargets, {
-        ignored: ignoreTargets,
-        ignoreInitial: true,
-    });
-
-    watcher.on('all', (event, path) => {
-        clearTimeout(restartTimeout);
-        restartTimeout = setTimeout(() => {
-            console.log('\n');
-            logger.info(
-                `Restarting due to critical file change: ${stress(path)}\n\n`,
-            );
-            // Nuxt Restart Hook won't work when unhandled Node exception is thrown!
-            // nuxt.callHook('restart', { hard: true, });
-            // So we kill the process and restart it in Erudit CLI instead.
-            exit(1337);
-        }, restartDelay);
-    });
-}

package/server/api/aside/major/nav/bookIds.ts

@@ -1,5 +0,0 @@
-import { getNavBookIds } from '@server/nav/utils';
-
-export default defineEventHandler(() => {
-    return getNavBookIds('short');
-});

package/server/api/aside/major/nav/bookNav/[...bookId].ts

@@ -1,17 +0,0 @@
-import { getNavNode } from '@server/nav/utils';
-import { createBookFrontNav } from '@server/repository/frontNav';
-
-export default defineEventHandler(async (event) => {
-    const bookId = getRouterParam(event, 'bookId');
-
-    if (!bookId) {
-        throw createError({
-            statusCode: 400,
-            statusText: 'Missing book ID!',
-        });
-    }
-
-    const bookNode = getNavNode(bookId);
-
-    return await createBookFrontNav(bookNode);
-});

package/server/api/aside/major/nav/global.ts

@@ -1,7 +0,0 @@
-import type { FrontNav } from '@erudit/shared/frontNav';
-import { ERUDIT_SERVER } from '@server/global';
-import { createGlobalFrontNav } from '@server/repository/frontNav';
-
-export default defineEventHandler(async () => {
-    return (await createGlobalFrontNav(ERUDIT_SERVER.NAV)) as FrontNav;
-});

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

@@ -1,18 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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

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

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

@@ -1,36 +0,0 @@
-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,13 +0,0 @@
-import { parseClientBitranLocation } from '@server/bitran/location';
-import { getBitranContent } from '@server/bitran/content';
-
-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/bitran/toc/[...location].ts

@@ -1,9 +0,0 @@
-import { parseClientBitranLocation } from '@server/bitran/location';
-import { getBitranToc } from '@server/bitran/toc';
-
-export default defineEventHandler(async (event) => {
-    const location = await parseClientBitranLocation(
-        event.context.params!.location,
-    );
-    return await getBitranToc(location);
-});

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

@@ -1,42 +0,0 @@
-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

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