erudit 3.0.0-dev.2 → 3.0.0-dev.21

package/module/paths.ts

@@ -1,22 +1,22 @@
-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}`,
-    );
-}
+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 +1,61 @@
-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.{js,ts}')),
-    // Erudit Bitran config in project root
-    ...globSync(projectPath('bitran.{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);
-    });
-}
+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/nuxt.config.ts

@@ -1,112 +1,126 @@
-import { elementPackages } from '@erudit-js/bitran-elements';
-
-import { eruditPath, projectPath } from './globalPath';
-
-export default defineNuxtConfig({
-    compatibilityDate: '2025-01-01',
-    devtools: { enabled: true },
-    future: { compatibilityVersion: 4 },
-    ssr: true,
-    alias: {
-        '@erudit': eruditPath(),
-        '@module': eruditPath('module'),
-        '@server': eruditPath('server/plugin'),
-        '@shared': eruditPath('shared'),
-        '@app': eruditPath('app'),
-        $: eruditPath('app/styles'),
-    },
-    modules: [eruditPath('module'), 'nuxt-my-icons'],
-    myicons: {
-        iconsDir: eruditPath('app/assets/icons'),
-    },
-    typescript: {
-        tsConfig: {
-            include: [eruditPath('**/*'), projectPath('**/*')],
-        },
-    },
-    build: {
-        transpile: [
-            '@bitran-js/renderer-vue',
-            '@erudit-js/bitran-elements',
-            'yaml',
-        ],
-    },
-    ignore: [
-        // Content assets
-        ...[
-            '**/{book,group,topic}.{js,ts}',
-            '**/{article,summary,practice,content}.bi',
-        ].map((pattern) => projectPath(`content/${pattern}`)),
-        // Contributors assets
-        ...['*/contributor.{js,ts}', '*/description.bi'].map((pattern) =>
-            projectPath(`contributors/${pattern}`),
-        ),
-    ],
-    nitro: {
-        preset: 'static',
-        plugins: [eruditPath('server/plugin')],
-        prerender: {
-            failOnError: false,
-        },
-        output: {
-            publicDir: projectPath('dist'),
-        },
-        publicAssets: [
-            {
-                baseURL: '/_erudit-asset/',
-                dir: eruditPath('app/public'),
-                maxAge: 60 * 60 * 24 * 30,
-            },
-            {
-                baseURL: '/_user-asset/public/',
-                dir: projectPath('public'),
-                maxAge: 60 * 60 * 24 * 30,
-            },
-            {
-                baseURL: '/_user-asset/content/',
-                dir: projectPath('content'),
-                maxAge: 60 * 60 * 24 * 30,
-            },
-            {
-                baseURL: '/_user-asset/contributor/',
-                dir: projectPath('contributors'),
-                maxAge: 60 * 60 * 24 * 30,
-            },
-        ],
-        esbuild: {
-            options: {
-                tsconfigRaw: {
-                    compilerOptions: {
-                        experimentalDecorators: true, // Make TypeORM work with Nuxt,
-                    },
-                },
-            },
-        },
-    },
-    vite: {
-        optimizeDeps: {
-            //noDiscovery: true,
-            include: [
-                '@bitran-js/core',
-                '@bitran-js/transpiler',
-                // '@bitran-js/renderer-vue',
-                // '@erudit-js/bitran-elements',
-                //
-                ...elementPackages,
-                //
-                'gradient-string',
-                '@floating-ui/vue',
-                'yaml',
-            ],
-        },
-        server: { fs: { strict: false } },
-        css: {
-            preprocessorOptions: {
-                scss: {
-                    api: 'modern-compiler',
-                    additionalData: `@use '$/utils' as *;`,
-                },
-            },
-        },
-    },
-});
+import {
+    PUBLIC_CONTENT_ASSET,
+    PUBLIC_ERUDIT_ASSET,
+    PUBLIC_USER_ASSET,
+} from './const';
+import { eruditPath, projectPath } from './globalPath';
+
+export default defineNuxtConfig({
+    compatibilityDate: '2025-01-01',
+    devtools: { enabled: true },
+    future: { compatibilityVersion: 4 },
+    ssr: true,
+    alias: {
+        '@erudit': eruditPath(),
+        '@module': eruditPath('module'),
+        '@server': eruditPath('server/plugin'),
+        '@shared': eruditPath('shared'),
+        '@app': eruditPath('app'),
+        $: eruditPath('app/styles'),
+    },
+    modules: [eruditPath('module'), 'nuxt-my-icons'],
+    myicons: {
+        iconsDir: eruditPath('app/assets/icons'),
+    },
+    features: {
+        inlineStyles: false,
+    },
+    typescript: {
+        tsConfig: {
+            include: [eruditPath('**/*'), projectPath('**/*')],
+        },
+    },
+    build: {
+        transpile: [
+            'yaml',
+            'photoswipe',
+            '@bitran-js/renderer-vue',
+            '@erudit-js/bitran-elements',
+        ],
+    },
+    ignore: [
+        // Content assets
+        ...[
+            '**/{book,group,topic}.{js,ts}',
+            '**/{article,summary,practice,content}.bi',
+        ].map((pattern) => projectPath(`content/${pattern}`)),
+        // Contributors assets
+        ...['*/contributor.{js,ts}', '*/description.bi'].map((pattern) =>
+            projectPath(`contributors/${pattern}`),
+        ),
+    ],
+    nitro: {
+        preset: 'github-pages',
+        plugins: [eruditPath('server/plugin')],
+        prerender: {
+            crawlLinks: true,
+            failOnError: false,
+            concurrency: 10,
+            routes: ['/robots.txt', '/sitemap.xml'],
+            ignore: [
+                (path: string) => {
+                    const regexps = [/#/gm, /\.json\?/gm];
+                    const shouldIgnore = regexps.some((re) => re.test(path));
+                    return shouldIgnore;
+                },
+            ],
+        },
+        output: {
+            publicDir: projectPath('dist'),
+        },
+        externals: {
+            inline: [/bitran-elements/],
+        },
+        publicAssets: [
+            {
+                baseURL: PUBLIC_ERUDIT_ASSET,
+                dir: eruditPath('app/public'),
+                maxAge: 60 * 60 * 24 * 30,
+            },
+            {
+                baseURL: PUBLIC_USER_ASSET,
+                dir: projectPath('public'),
+                maxAge: 60 * 60 * 24 * 30,
+            },
+            {
+                baseURL: PUBLIC_CONTENT_ASSET,
+                dir: projectPath('content'),
+                maxAge: 60 * 60 * 24 * 30,
+            },
+        ],
+        esbuild: {
+            options: {
+                charset: 'utf8',
+                tsconfigRaw: {
+                    compilerOptions: {
+                        experimentalDecorators: true, // Make TypeORM work with Nuxt,
+                    },
+                },
+            },
+        },
+    },
+    vite: {
+        optimizeDeps: {
+            include: [
+                'yaml',
+                'photoswipe',
+                '@floating-ui/vue',
+                '@bitran-js/core',
+                '@bitran-js/transpiler',
+                '@bitran-js/renderer-vue',
+                '@erudit-js/bitran-elements',
+            ],
+        },
+        server: {
+            fs: { strict: false },
+        },
+        css: {
+            preprocessorOptions: {
+                scss: {
+                    api: 'modern-compiler',
+                    additionalData: `@use '$/utils' as *;`,
+                },
+            },
+        },
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "erudit",
-    "version": "3.0.0-dev.2",
+    "version": "3.0.0-dev.21",
     "type": "module",
     "description": "🤓 CMS for perfect educational sites.",
     "license": "MIT",
@@ -10,25 +10,32 @@
         "url": "git+https://github.com/erudit-js/erudit.git",
         "directory": "packages/erudit"
     },
+    "bin": {
+        "erudit-cli": "bin/erudit.mjs",
+        "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"
+    },
     "dependencies": {
-        "erudit-cli": "3.0.0-dev.2",
-        "erudit-cog": "3.0.0-dev.2",
-        "@bitran-js/core": "1.0.0-dev.7",
-        "@bitran-js/transpiler": "1.0.0-dev.7",
-        "@bitran-js/renderer-vue": "1.0.0-dev.7",
-        "@erudit-js/bitran-elements": "1.0.0-dev.5",
+        "@bitran-js/core": "1.0.0-dev.13",
+        "@bitran-js/renderer-vue": "1.0.0-dev.13",
+        "@bitran-js/transpiler": "1.0.0-dev.13",
         "@floating-ui/vue": "^1.1.6",
         "chalk": "^5.4.1",
         "chokidar": "^4.0.3",
-        "consola": "^3.4.0",
-        "glob": "^11.0.1",
-        "image-size": "^1.2.0",
-        "nuxt": "3.15.4",
-        "nuxt-my-icons": "1.0.2",
-        "sass": "^1.85.1",
-        "slugify": "^1.6.6",
+        "consola": "^3.4.2",
+        "esbuild": "^0.25.4",
+        "glob": "^11.0.2",
+        "image-size": "^2.0.2",
+        "jiti": "^2.4.2",
+        "nuxt": "3.17.3",
+        "nuxt-my-icons": "1.1.1",
+        "sass": "^1.87.0",
         "sqlite3": "^5.1.7",
-        "typeorm": "^0.3.21",
+        "typeorm": "^0.3.23",
         "vue": "latest",
         "vue-router": "latest"
     }

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

@@ -1,5 +1,5 @@
-import { ERUDIT_SERVER } from '@server/global';
-
-export default defineEventHandler(() => {
-    return Object.keys(ERUDIT_SERVER.NAV_BOOKS || {});
-});
+import { getNavBookIds } from '@server/nav/utils';
+
+export default defineEventHandler(() => {
+    return getNavBookIds('short');
+});

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

@@ -1,20 +1,17 @@
-import { ERUDIT_SERVER } from '@server/global';
-import { createBookFrontNav } from '@server/repository/frontNav';
-
-export default defineEventHandler(async (event) => {
-    const bookId = getRouterParam(event, 'bookId');
-
-    if (
-        !bookId ||
-        !ERUDIT_SERVER.NAV_BOOKS ||
-        !(bookId in ERUDIT_SERVER.NAV_BOOKS)
-    )
-        throw createError({
-            statusCode: 400,
-            statusText: `Unknown book id "${bookId}"!`,
-        });
-
-    const bookNode = ERUDIT_SERVER.NAV_BOOKS[bookId]!;
-
-    return await createBookFrontNav(bookNode);
-});
+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 +1,7 @@
-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, false)) as FrontNav;
-});
+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

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

@@ -0,0 +1,13 @@
+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);
+});