erudit 3.0.0-dev.11 → 3.0.0-dev.12

package/app/components/SiteMain.vue

@@ -22,7 +22,7 @@
 
     @include bp.below('mobile') {
         --_pMainBase: var(--_bitran_asideWidth);
-        font-size: 14px;
+        font-size: 15px;
     }
 
     .mainInner {

package/app/components/aside/major/panes/nav/Nav.vue

@@ -7,6 +7,8 @@ import {
     navBookVisible,
 } from '@app/scripts/aside/major/nav';
 
+import { detectContentBookId } from '@shared/content/bookId';
+
 import NavGlobal from './NavGlobal.vue';
 import NavBook from './NavBook.vue';
 
@@ -23,12 +25,15 @@ asideMajorNav.globalNav ||= (await $fetch('/api/aside/major/nav/global', {
 
 const checkIfInsideBook = () => {
     if (contentRoute.value) {
-        for (const bookId of asideMajorNav.booksIds) {
-            if (contentRoute.value.contentId.startsWith(bookId)) {
-                navBookId.value = bookId;
-                insideNavBook.value = true;
-                return;
-            }
+        const bookId = detectContentBookId(
+            contentRoute.value.contentId,
+            asideMajorNav.booksIds
+        );
+
+        if (bookId) {
+            navBookId.value = bookId;
+            insideNavBook.value = true;
+            return;
         }
     }
 

package/app/components/aside/major/panes/nav/fnav/FNavFlags.vue

@@ -2,7 +2,7 @@
 import type { ContentFlag } from '@erudit-js/cog/schema';
 import { flagsData } from '@app/scripts/flag';
 
-defineProps<{ flags: Record<ContentFlag, boolean> }>();
+defineProps<{ flags: Partial<Record<ContentFlag, boolean>> }>();
 
 const phrases = Object.values(flagsData).map((data) => data.title);
 const phrase = await usePhrases(...phrases);

package/app/components/aside/minor/Contribute.vue

@@ -3,7 +3,7 @@ import eruditConfig from '#erudit/config';
 
 import AsideOverlayPane from '../utils/AsideOverlayPane.vue';
 
-const props = defineProps<{ fullContentId: string }>();
+const props = defineProps<{ contentId: string }>();
 const phrase = await usePhrases(
     'make_contribution',
     'material_improvement',
@@ -23,7 +23,7 @@ const issueLink = computed(() => {
 const editPageLink = computed(() => {
     const ghRepository = eruditConfig.repository;
     return ghRepository
-        ? `https://github.com/${ghRepository.name}/tree/${ghRepository.branch}/content/${props.fullContentId}`
+        ? `https://github.com/${ghRepository.name}/tree/${ghRepository.branch}/content/${props.contentId}`
         : null;
 });
 </script>

package/app/components/aside/minor/content/AsideMinorContent.vue

@@ -40,7 +40,7 @@ watch(contentData, () => (contributePaneVisible.value = false));
             {{ phrase.no_contributors }}
         </section>
         <AsideMinorContribute
-            :fullContentId="contentData.fullContentId"
+            :contentId="contentData.contentId"
             v-model:pane="contributePaneVisible"
         />
     </AsideMinorPane>

package/app/components/aside/minor/topic/AsideMinorTopic.vue

@@ -18,7 +18,7 @@ watch(topicData, () => (contributePaneVisible.value = false));
         <TopicToc />
         <TopicContributors v-if="topicData.contributors" />
         <AsideMinorContribute
-            :fullContentId="topicData.fullContentId"
+            :contentId="topicData.topicId"
             v-model:pane="contributePaneVisible"
         />
     </AsideMinorPane>

package/app/components/aside/minor/topic/TopicContributors.vue

@@ -27,9 +27,9 @@ onMounted(() => {
     watch(
         topicData,
         () => {
-            if (previousFullId === topicData.value.fullContentId) return;
+            if (previousFullId === topicData.value.topicId) return;
 
-            previousFullId = topicData.value.fullContentId;
+            previousFullId = topicData.value.topicId;
             showcase.value = [...topicData.value.contributors!]
                 .sort(() => 0.5 - Math.random())
                 .slice(0, counter.value.showcase);

package/app/components/aside/minor/topic/TopicToc.vue

@@ -174,12 +174,7 @@ onMounted(() => {
 
             if (!topicData.value.location || !topicLocation.value) return;
 
-            if (
-                stringifyBitranLocation(topicData.value.location) ===
-                stringifyBitranLocation(topicLocation.value)
-            ) {
-                enableLiveToc();
-            }
+            enableLiveToc();
         },
         { immediate: true },
     );

package/app/components/aside/minor/topic/TopicTocItem.vue

@@ -6,6 +6,8 @@ const productName = props.tocItem.productName;
 const productIcon = await useBitranElementIcon(productName);
 const productPhrase = await useBitranElementLanguage(productName);
 
+const pretty = useFormatText();
+
 function tocItemClick(event: MouseEvent): void {
     navigateTo({
         query: {
@@ -20,7 +22,7 @@ function tocItemClick(event: MouseEvent): void {
 
 <template>
     <TreeItem
-        :label="tocItem.title || productPhrase('_element_title')"
+        :label="pretty(tocItem.title || productPhrase('_element_title'))"
         :level="tocItem.level"
         :link="`?element=${tocItem.id}`"
         :svg="productIcon"

package/app/components/main/utils/Breadcrumb.vue

@@ -13,7 +13,7 @@ function getIcon(contextIcon: string) {
 
 <template>
     <section :class="$style.breadcrumb">
-        <template v-for="contextItem of context.slice(0, -1)">
+        <template v-for="contextItem of context.slice(0, -1).filter(item => !item.hidden)">
             <Link :to="contextItem.href" :class="$style.breadcrumbItem">
                 <MyIcon :name="getIcon(contextItem.icon)" wrapper="span" />
                 {{ contextItem.title }}

package/app/components/preview/PreviewScreen.vue

@@ -5,7 +5,7 @@ import { buildPreviewData } from '@app/scripts/preview/build';
 import { getPreviewDisplayComponent } from '@app/scripts/preview/display';
 import { createPreviewError } from '@app/scripts/preview/data/alert';
 
-import { PreviewDisplayAlert } from '#components';
+import { LazyPreviewDisplayAlert } from '#components';
 
 const { request } = defineProps<{ request: PreviewRequest }>();
 const height = defineModel<number>('height');
@@ -35,7 +35,7 @@ const setupDisplay = setTimeout(async () => {
             message: error?.message || error,
         });
 
-        DisplayComponent.value = PreviewDisplayAlert;
+        DisplayComponent.value = LazyPreviewDisplayAlert;
     }
 
     await nextTick();

package/app/components/preview/display/PageLink.vue

@@ -9,7 +9,7 @@ const phrase = await usePhrases('internal_link_warn');
 
 <template>
     <PreviewDisplay :footer="data.footer">
-        <div :class="$style.wrapper">{{ phrase.internal_link_warn }}</div>
+        <div :class="$style.wrapper">{{ data.description || phrase.internal_link_warn }}</div>
     </PreviewDisplay>
 </template>
 

package/app/composables/bitranContent.ts

@@ -29,8 +29,8 @@ export async function useBitranContent(
             })();
         }
 
-        const apiRoute = `/api/bitran/content/${encodeBitranLocation(stringifyBitranLocation(location.value!))}`;
-        nuxtApp.runWithContext(() => prerenderRoutes(apiRoute));
+        const contentApiRoute = `/api/bitran/content/${encodeBitranLocation(stringifyBitranLocation(location.value!))}`;
+        nuxtApp.runWithContext(() => prerenderRoutes(contentApiRoute));
 
         // @ts-ignore
         contentPromise = (async () => {
@@ -49,7 +49,7 @@ export async function useBitranContent(
             if (payload.location === locationString) {
                 stringContent = payload;
             } else {
-                stringContent = await $fetch(apiRoute, {
+                stringContent = await $fetch(contentApiRoute, {
                     responseType: 'json',
                 });
 

package/app/composables/contentPage.ts

@@ -62,17 +62,16 @@ export function useContentPage(contentData: Ref<ContentData>) {
                 contentData.value.generic.title ||
                 contentData.value.generic.contentId.split('/').pop();
 
-            if (contentData.value.type !== 'book') {
-                const bookTitle = contentData.value?.bookTitle;
-                title += bookTitle ? ` | ${bookTitle}` : '';
-            }
-
             if (contentRoute.value!.type === 'topic') {
                 const topicPart = contentRoute.value!.topicPart;
-
                 if (topicPart !== 'article') title += ` | ${phrase[topicPart]}`;
             }
 
+            if (contentData.value.type !== 'book') {
+                const bookTitle = contentData.value?.bookTitle;
+                title += bookTitle ? ` | ${bookTitle}` : '';
+            }
+
             title +=
                 ' - ' +
                 (eruditConfig.seo?.title ||
@@ -91,7 +90,9 @@ export function useContentPage(contentData: Ref<ContentData>) {
                 contentData.value.generic?.description;
 
             if (customDescription) {
-                seo.description.value = customDescription;
+                seo.description.value = customDescription
+                    .trim()
+                    .replace(/\n/g, ' ');
                 return;
             }
 

package/app/composables/formatText.ts

@@ -1,5 +1,16 @@
 import eruditConfig from '#erudit/config';
 
+export interface FormatState {
+    quoteOpen: boolean;
+}
+
+const defaultFormatState: FormatState = {
+    quoteOpen: false,
+};
+
+export type FormatFunction = (text: string, state?: FormatState) => string;
+export type FormatterFunction = (text: string, state: FormatState) => string;
+
 let formatFunction: FormatFunction;
 
 export function useFormatText() {
@@ -11,10 +22,8 @@ export function useFormatText() {
     return formatFunction;
 }
 
-type FormatFunction = (text: string) => string;
-
 function createFormatFunction(language?: string): FormatFunction {
-    const formatters: FormatFunction[] = [];
+    const formatters: FormatterFunction[] = [];
 
     //
     // Em Dashes
@@ -36,10 +45,11 @@ function createFormatFunction(language?: string): FormatFunction {
             }
         })();
 
-        formatters.push((text) => {
-            let open = false;
+        formatters.push((text, state) => {
             return text.replaceAll(/"/gm, () => {
-                return (open = !open) ? quoteSymbols[0] : quoteSymbols[1];
+                return (state.quoteOpen = !state.quoteOpen)
+                    ? quoteSymbols[0]
+                    : quoteSymbols[1];
             });
         });
     }
@@ -60,10 +70,13 @@ function createFormatFunction(language?: string): FormatFunction {
     //
     //
 
-    function formatText(text: string): string {
+    function formatText(
+        text: string,
+        state: FormatState = defaultFormatState,
+    ): string {
         if (!text) return text;
 
-        for (const formatter of formatters) text = formatter(text);
+        for (const formatter of formatters) text = formatter(text, state);
 
         return text;
     }

package/app/composables/phrases.ts

@@ -15,7 +15,6 @@ const functionPhrases: Record<string, Function> = {};
 const phraseApiRoute = (phraseId: EruditPhraseId) =>
     `/api/language/phrase/${phraseId}`;
 const functionsApiRoute = '/api/language/functions';
-const phraseIdsApiRoute = '/api/language/phraseIds';
 
 export function usePhrases<T extends EruditPhraseId[]>(
     ...phraseIds: T
@@ -26,11 +25,9 @@ export function usePhrases<T extends EruditPhraseId[]>(
         nuxt.payload.data[payloadKey] ||=
             {});
 
-    const prerenderAllPromise = prerenderAllPhrases();
     const prepareFunctionsPromise = prepareFunctions(payload);
 
     return (async () => {
-        await prerenderAllPromise;
         await prepareFunctionsPromise;
 
         payload.strPhrases ||= {};
@@ -58,19 +55,6 @@ export function usePhrases<T extends EruditPhraseId[]>(
     })();
 }
 
-async function prerenderAllPhrases() {
-    if (import.meta.dev) return;
-
-    if (import.meta.client) return;
-
-    const nuxt = useNuxtApp();
-
-    const phraseIds = await $fetch(phraseIdsApiRoute);
-    nuxt.runWithContext(() =>
-        prerenderRoutes(phraseIds.map((phraseId) => phraseApiRoute(phraseId))),
-    );
-}
-
 async function prepareFunctions(payload: LanguagePayload) {
     if (payload?.strFunctions) return;
 

package/app/plugins/prerender.server.ts

@@ -0,0 +1,22 @@
+let alreadyPrerendered = false;
+let isPrerendering = false;
+
+export default defineNuxtPlugin({
+    name: 'erudit-prerender',
+    async setup(_nuxt) {
+        if (import.meta.dev) {
+            return; // Server is available so no need to prerender in dev mode
+        }
+
+        if (alreadyPrerendered || isPrerendering) {
+            return;
+        }
+
+        isPrerendering = true;
+
+        const routesToPrerender = await $fetch<string[]>('/api/prerender');
+        _nuxt.runWithContext(() => prerenderRoutes(routesToPrerender));
+
+        alreadyPrerendered = true;
+    },
+});

package/app/scripts/preview/build.ts

@@ -1,4 +1,5 @@
 import { PreviewDataType, type PreviewData } from './data';
+import { createPreviewError } from './data/alert';
 import { PreviewRequestType, type PreviewRequest } from './request';
 import { PreviewThemeName } from './state';
 
@@ -26,8 +27,6 @@ export async function buildPreviewData(
                 'expected_page_hash',
             );
 
-            const { createPreviewError } = await import('./data/alert');
-
             return createPreviewError({
                 title: phrase.preview_missing_title,
                 message: phrase.preview_missing_explain_mismatch,
@@ -40,8 +39,6 @@ export async function buildPreviewData(
                 'element_id',
             );
 
-            const { createPreviewError } = await import('./data/alert');
-
             return createPreviewError({
                 title: phrase.preview_missing_title,
                 message: phrase.preview_missing_explain,
@@ -72,7 +69,6 @@ export async function buildPreviewData(
         if (result) return result;
     }
 
-    const { createPreviewError } = await import('./data/alert');
     throw createPreviewError({
         message: `Unable to build preview data for request!`,
         pre: JSON.stringify(request, null, 4),

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

@@ -5,6 +5,7 @@ import type { PreviewFooter } from '../footer';
 export interface PreviewDataPageLink extends PreviewDataBase {
     type: PreviewDataType.PageLink;
     footer: PreviewFooter;
+    description?: string;
 }
 
 export async function buildPageLink(

package/app/styles/normalize.scss

@@ -47,17 +47,3 @@ h5,
 h6 {
     overflow-wrap: break-word;
 }
-
-/* 8. Improve line wrapping */
-p {
-    text-wrap: pretty;
-}
-
-h1,
-h2,
-h3,
-h4,
-h5,
-h6 {
-    text-wrap: balance;
-}

package/globals/content.ts

@@ -1,6 +1,7 @@
 import type {
     BookConfig,
     ContentReferences,
+    ContentReferenceSource,
     GroupConfig,
     TopicConfig,
 } from '@erudit-js/cog/schema';
@@ -20,3 +21,7 @@ export function defineTopic(topic: Partial<TopicConfig>) {
 export function defineContentReferences(references: ContentReferences) {
     return references;
 }
+
+export function defineContentSource(source: ContentReferenceSource) {
+    return source;
+}

package/module/imports.ts

@@ -27,6 +27,7 @@ export function setupGlobalImports() {
                 'defineGroup',
                 'defineTopic',
                 'defineContentReferences',
+                'defineContentSource',
             ];
             return imports.map((name) => ({
                 name,

package/nuxt.config.ts

@@ -53,11 +53,6 @@ export default defineNuxtConfig({
             projectPath(`contributors/${pattern}`),
         ),
     ],
-    esbuild: {
-        options: {
-            charset: 'utf8',
-        },
-    },
     nitro: {
         preset: 'github-pages',
         plugins: [eruditPath('server/plugin')],
@@ -94,6 +89,7 @@ export default defineNuxtConfig({
         ],
         esbuild: {
             options: {
+                charset: 'utf8',
                 tsconfigRaw: {
                     compilerOptions: {
                         experimentalDecorators: true, // Make TypeORM work with Nuxt,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "erudit",
-    "version": "3.0.0-dev.11",
+    "version": "3.0.0-dev.12",
     "type": "module",
     "description": "🤓 CMS for perfect educational sites.",
     "license": "MIT",
@@ -15,14 +15,14 @@
         "erudit": "bin/erudit.mjs"
     },
     "peerDependencies": {
-        "@erudit-js/cog": "3.0.0-dev.11",
-        "@erudit-js/cli": "3.0.0-dev.11",
-        "@erudit-js/bitran-elements": "3.0.0-dev.11"
+        "@erudit-js/cog": "3.0.0-dev.12",
+        "@erudit-js/cli": "3.0.0-dev.12",
+        "@erudit-js/bitran-elements": "3.0.0-dev.12"
     },
     "dependencies": {
-        "@bitran-js/core": "1.0.0-dev.12",
-        "@bitran-js/renderer-vue": "1.0.0-dev.12",
-        "@bitran-js/transpiler": "1.0.0-dev.12",
+        "@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",
@@ -30,7 +30,7 @@
         "glob": "^11.0.1",
         "image-size": "^2.0.2",
         "jiti": "^2.4.2",
-        "nuxt": "3.16.2",
+        "nuxt": "3.17.0",
         "nuxt-my-icons": "1.0.2",
         "sass": "^1.86.2",
         "sqlite3": "^5.1.7",

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

@@ -1,22 +1,26 @@
 import { isTopicPart, locationFromPath } from '@erudit-js/cog/schema';
 
 import type { AsideMinorContent, AsideMinorTopic } from '@shared/aside/minor';
-import { getBitranToc } from '@erudit/server/plugin/bitran/toc';
+import { getBitranToc } from '@server/bitran/toc';
 import {
     getContentContributors,
-    getFullContentId,
     getPreviousNext,
-} from '@erudit/server/plugin/repository/content';
-import { getTopicPartsLinks } from '@erudit/server/plugin/repository/topic';
+} from '@server/repository/content';
+import { getTopicPartsLinks } from '@server/repository/topic';
+import {
+    getFullContentId,
+    getShortContentId,
+} from '@server/repository/contentId';
 
 export default defineEventHandler(async (event) => {
     const query = getQuery<{ path: string }>(event);
 
-    if (!query.path)
+    if (!query.path) {
         throw createError({
             statusCode: 400,
             statusText: 'Missing "path" query parameter!',
         });
+    }
 
     const path = query.path.substring(1);
     const pathStart = path.split('/')[0];
@@ -32,14 +36,18 @@ export default defineEventHandler(async (event) => {
 async function createTopicData(path: string): Promise<AsideMinorTopic> {
     const location = locationFromPath(path);
 
-    if (!location)
+    if (!location) {
         throw createError({
             statusCode: 400,
             statusText: `Provided path "${path}" is not a valid topic location!`,
         });
+    }
+
+    if (location.path) {
+        location.path = await getFullContentId(location.path);
+    }
 
     const contentId = location.path;
-    const fullContentId = (await getFullContentId(contentId))!;
 
     const toc = await getBitranToc(location);
     const previousNext = await getPreviousNext(contentId);
@@ -48,7 +56,7 @@ async function createTopicData(path: string): Promise<AsideMinorTopic> {
 
     return {
         type: 'topic',
-        fullContentId,
+        topicId: contentId,
         location,
         toc,
         nav: {
@@ -63,14 +71,14 @@ async function createContentData(
     type: string,
     path: string,
 ): Promise<AsideMinorContent> {
-    const contentId = path.split('/').slice(1).join('/');
-    const fullContentId = (await getFullContentId(contentId))!;
+    const rawContentId = path.split('/').slice(1).join('/');
+    const contentId = (await getFullContentId(rawContentId))!;
     const previousNext = await getPreviousNext(contentId);
     const contributors = await getContentContributors(contentId);
 
     return {
         type: type as any,
-        fullContentId,
+        contentId,
         nav: previousNext,
         contributors,
     };

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

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

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

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

package/server/api/content/data.ts

@@ -1,6 +1,7 @@
 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';
@@ -8,13 +9,15 @@ import type { ContentGroupData } from '@shared/content/data/type/group';
 import type { ContentBookData } from '@shared/content/data/type/book';
 
 export default defineEventHandler(async (event) => {
-    const contentId = getQuery(event)?.contentId as string;
+    let contentId = getQuery(event)?.contentId as string;
+    contentId = await getFullContentId(contentId);
 
-    if (!contentId)
+    if (!contentId) {
         throw createError({
             statusCode: 400,
             statusText: 'Missing content ID!',
         });
+    }
 
     const generic = await getContentGenericData(contentId);