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

package/server/api/prerender.ts

@@ -0,0 +1,120 @@
+import {
+    encodeBitranLocation,
+    parseBitranLocation,
+    stringifyBitranLocation,
+} from '@erudit-js/cog/schema';
+
+import { DbUnique } from '@server/db/entities/Unique';
+import { ERUDIT_SERVER } from '@server/global';
+import { DbBook } from '@server/db/entities/Book';
+import { DbTopic } from '@server/db/entities/Topic';
+import { DbGroup } from '@server/db/entities/Group';
+import { DbContributor } from '@server/db/entities/Contributor';
+import { getShortContentId } from '@server/repository/contentId';
+
+export default defineEventHandler(async () => {
+    const routes: string[] = [];
+    routes.push(...language());
+    routes.push(...(await previewUniques()));
+    routes.push(...(await previewPages()));
+
+    return routes;
+});
+
+//
+//
+//
+
+function language() {
+    const phraseRoutes = Object.keys(ERUDIT_SERVER.LANGUAGE?.phrases || []).map(
+        (phraseId) => `/api/language/phrase/${phraseId}`,
+    );
+    return ['/api/language/functions', ...phraseRoutes];
+}
+
+async function previewUniques() {
+    const dbUniques = await ERUDIT_SERVER.DB.manager.find(DbUnique, {
+        select: ['location'],
+    });
+
+    if (!dbUniques) {
+        return [];
+    }
+
+    const routes: string[] = [];
+    for (const dbUnique of dbUniques) {
+        const location = parseBitranLocation(dbUnique.location);
+
+        if (location.path) {
+            location.path = await getShortContentId(location.path);
+        }
+
+        routes.push(
+            `/api/preview/unique/${encodeBitranLocation(stringifyBitranLocation(location))}`,
+        );
+    }
+    return routes;
+}
+
+async function previewPages() {
+    const pageRoutes: string[] = [];
+
+    // Books
+
+    const dbBooks = await ERUDIT_SERVER.DB.manager.find(DbBook, {
+        select: ['contentId'],
+    });
+
+    if (dbBooks) {
+        for (const dbBook of dbBooks) {
+            const bookId = await getShortContentId(dbBook.contentId);
+            pageRoutes.push(`/api/preview/page/book/${bookId}`);
+        }
+    }
+
+    // Topics
+
+    const dbTopics = await ERUDIT_SERVER.DB.manager.find(DbTopic, {
+        select: ['contentId', 'parts'],
+    });
+
+    if (dbTopics) {
+        for (const dbTopic of dbTopics) {
+            const topicId = await getShortContentId(dbTopic.contentId);
+            for (const part of dbTopic.parts) {
+                pageRoutes.push(`/api/preview/page/${part}/${topicId}`);
+            }
+        }
+    }
+
+    // Groups
+
+    const dbGroups = await ERUDIT_SERVER.DB.manager.find(DbGroup, {
+        select: ['contentId'],
+    });
+
+    if (dbGroups) {
+        for (const dbGroup of dbGroups) {
+            const groupId = await getShortContentId(dbGroup.contentId);
+            pageRoutes.push(`/api/preview/page/group/${groupId}`);
+        }
+    }
+
+    // Contributors
+
+    const dbContributors = await ERUDIT_SERVER.DB.manager.find(DbContributor, {
+        select: ['contributorId'],
+    });
+
+    if (dbContributors) {
+        for (const dbContributor of dbContributors) {
+            pageRoutes.push(
+                `/api/preview/page/contributor/${dbContributor.contributorId}`,
+            );
+        }
+    }
+
+    // // //
+
+    return pageRoutes;
+}

package/server/api/preview/page/[...parts].ts

@@ -1,13 +1,17 @@
+import type { LinkTargetPageType } from '@erudit-js/bitran-elements/link/target';
+import { isContentType } from '@erudit-js/cog/schema';
+
 import {
     getContentContext,
     getTopicPartContext,
     getContributorContext,
-} from '@erudit/server/plugin/content/context';
-
-import type { LinkTargetPageType } from '@erudit-js/bitran-elements/link/target';
+} from '@server/content/context';
+import { getFullContentId } from '@server/repository/contentId';
+import { ERUDIT_SERVER } from '@server/global';
+import { DbContent } from '@server/db/entities/Content';
 
-import type { PreviewDataPageLink } from '@app/scripts/preview/data/pageLink';
 import type { Context, ContextItem } from '@erudit/shared/content/context';
+import type { PreviewDataPageLink } from '@app/scripts/preview/data/pageLink';
 
 export default defineEventHandler<Promise<PreviewDataPageLink>>(
     async (event) => {
@@ -37,8 +41,30 @@ export default defineEventHandler<Promise<PreviewDataPageLink>>(
             .map((c) => c.title)
             .join(' / ');
 
+        const description = await (async () => {
+            if (!isContentType(pageType)) {
+                return;
+            }
+
+            const fullContentId = await getFullContentId(contentId);
+            const dbContent = await ERUDIT_SERVER.DB.manager.findOne(
+                DbContent,
+                {
+                    select: ['description'],
+                    where: { contentId: fullContentId },
+                },
+            );
+
+            if (!dbContent) {
+                return;
+            }
+
+            return dbContent.description?.trim();
+        })();
+
         return <PreviewDataPageLink>{
             type: 'page-link',
+            description,
             footer: {
                 secondary:
                     (contextStr ? contextStr + ' • ' : '') +

package/server/api/preview/unique/{[location].ts → [...location].ts}

@@ -2,13 +2,12 @@ import {
     stringifyBitranLocation,
     type BitranContext,
 } from '@erudit-js/cog/schema';
-import type { BitranContent } from '@bitran-js/renderer-vue';
 
-import { parseUrlLocation } from '@server/bitran/location';
 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 type { Context } from '@shared/content/context';
 import type { StringBitranContent } from '@erudit/shared/bitran/stringContent';
@@ -26,7 +25,9 @@ interface ReturnType {
 export default defineEventHandler<Promise<ReturnType>>(async (event) => {
     setResponseHeader(event, 'Content-Type', 'application/json; charset=utf-8');
 
-    const location = parseUrlLocation(getRouterParam(event, 'location') || '');
+    const location = await parseClientBitranLocation(
+        event.context.params!.location,
+    );
 
     const context = await getLocationContext(location);
 

package/server/plugin/bitran/content.ts

@@ -1,6 +1,5 @@
 import {
     BlockErrorNode,
-    BlockNode,
     BlocksNode,
     createRenderData,
     ElementNode,
@@ -12,7 +11,6 @@ import {
     isTopicPart,
     mergeAliases,
     NO_ALIASES,
-    setEruditBitranRuntime,
     stringifyBitranLocation,
     type BitranContext,
     type BitranLocation,
@@ -111,17 +109,13 @@ async function createBitranContent(
     biCode: string,
     generatePrerenderData: boolean = true,
 ): Promise<StringBitranContent> {
-    const bitranTranspiler = await createBitranTranspiler();
-
     const runtime: EruditBitranRuntime = {
         eruditConfig: ERUDIT_SERVER.CONFIG,
-        context,
         insideInclude: false,
+        context,
     };
 
-    [bitranTranspiler.parser, bitranTranspiler.stringifier].forEach((item) =>
-        setEruditBitranRuntime(item, runtime),
-    );
+    const bitranTranspiler = await createBitranTranspiler(runtime);
 
     const renderDataStorage: RenderDataStorage = {};
 
@@ -183,14 +177,7 @@ async function resolveInclude(
     let _blocks;
 
     try {
-        const blocks: BlockNode[] = [];
-
-        await traverseInclude(includeNode, context, {
-            step: async ({ _node }) => {
-                if (_node instanceof BlockNode) blocks.push(_node);
-            },
-        });
-
+        const blocks = await traverseInclude(includeNode, context, {});
         const blocksNode = new BlocksNode(includeNode);
         blocksNode.setNodes(blocks);
         _blocks = blocksNode;

package/server/plugin/bitran/elements/include.ts

@@ -3,7 +3,6 @@ import type { BitranTranspiler } from '@bitran-js/transpiler';
 import {
     parseBitranLocation,
     parsePartialBitranLocation,
-    setEruditBitranRuntime,
     stringifyBitranLocation,
     tryReplaceAlias,
     type BitranAliases,
@@ -41,7 +40,7 @@ export async function traverseInclude(
         step?: TraverseStepFn;
         leave?: TraverseLeaveFn;
     },
-) {
+): Promise<BlockNode[]> {
     const entryLocation = stringifyBitranLocation(
         parsePartialBitranLocation(includeNode.id, context.location),
     );
@@ -58,7 +57,7 @@ export async function traverseInclude(
     };
 
     try {
-        await _traverseStep(
+        return await _traverseInclude(
             includeNode,
             absEntryLocation,
             context.aliases,
@@ -79,7 +78,7 @@ export async function traverseInclude(
     }
 }
 
-async function _traverseStep(
+async function _traverseInclude(
     includeNode: IncludeNode,
     location: string,
     aliases: BitranAliases,
@@ -89,7 +88,7 @@ async function _traverseStep(
         leave?: TraverseLeaveFn;
     },
     travelMap: Record<string, string | null>,
-) {
+): Promise<BlockNode[]> {
     let includeTargetLocation: string;
 
     try {
@@ -144,15 +143,11 @@ async function _traverseStep(
         aliases: dbUnique.context.aliases,
     };
 
-    const bitranTranspiler = await createBitranTranspiler();
-
-    [bitranTranspiler.parser, bitranTranspiler.stringifier].forEach((item) =>
-        setEruditBitranRuntime(item, {
-            eruditConfig: ERUDIT_SERVER.CONFIG,
-            context: structuredClone(context),
-            insideInclude: true,
-        }),
-    );
+    const bitranTranspiler = await createBitranTranspiler({
+        eruditConfig: ERUDIT_SERVER.CONFIG,
+        context: structuredClone(context),
+        insideInclude: true,
+    });
 
     if (listeners.enter) {
         await listeners.enter({
@@ -168,7 +163,7 @@ async function _traverseStep(
 
     let stepErrorMessage: string | Error | undefined;
 
-    await bitranTranspiler.parser.parse(dbUnique.content, {
+    const rootNode = await bitranTranspiler.parser.parse(dbUnique.content, {
         step: async (node) => {
             if (stepErrorMessage) return;
 
@@ -193,7 +188,7 @@ async function _traverseStep(
             }
 
             try {
-                await _traverseStep(
+                await _traverseInclude(
                     node,
                     includeTargetLocation,
                     context.aliases,
@@ -218,6 +213,8 @@ async function _traverseStep(
             _location: includeTargetLocation,
         });
     }
+
+    return (rootNode.children as BlockNode[]) ?? [];
 }
 
 function printIncludeTarget(target: string) {

package/server/plugin/bitran/location.ts

@@ -3,23 +3,37 @@ import {
     parseBitranLocation,
 } from '@erudit-js/cog/schema';
 
-export function parseUrlLocation(urlLocation: string) {
-    urlLocation = decodeURIComponent(urlLocation);
-    urlLocation = decodeBitranLocation(urlLocation);
+import { getFullContentId } from '@server/repository/contentId';
 
-    if (!urlLocation)
+export async function parseClientBitranLocation(clientLocation: string) {
+    clientLocation = decodeURIComponent(clientLocation);
+    clientLocation = decodeBitranLocation(clientLocation);
+
+    if (!clientLocation) {
         throw createError({
-            statusCode: 500,
+            statusCode: 400,
             statusText: 'Empty content location router parameter!',
         });
+    }
 
     try {
-        return parseBitranLocation(urlLocation);
-    } catch (error: any) {
+        const location = parseBitranLocation(clientLocation);
+
+        if (location.path) {
+            location.path = await getFullContentId(location.path);
+        }
+
+        return location;
+    } catch (_error) {
+        let error = `Failed to parse client location "${clientLocation}"!`;
+
+        if (_error) {
+            error += '\n\n' + _error;
+        }
+
         throw createError({
-            statusCode: 404,
-            statusText:
-                error?.message || `Can't parse location "${urlLocation}"!`,
+            statusCode: 400,
+            statusText: error,
         });
     }
 }

package/server/plugin/bitran/toc.ts

@@ -1,5 +1,5 @@
 import { type ElementNode } from '@bitran-js/core';
-import type { BitranLocation } from '@erudit-js/cog/schema';
+import { NO_ALIASES, type BitranLocation } from '@erudit-js/cog/schema';
 import {
     headingName,
     HeadingNode,
@@ -16,7 +16,12 @@ import { createBitranTranspiler } from './transpiler';
 
 export async function getBitranToc(location: BitranLocation) {
     const content = await getBitranContent(location, false);
-    const bitranCore = await createBitranTranspiler();
+
+    const bitranCore = await createBitranTranspiler({
+        eruditConfig: ERUDIT_SERVER.CONFIG,
+        insideInclude: false,
+        context: { aliases: NO_ALIASES(), location },
+    });
 
     const toc: Toc = [];
 

package/server/plugin/bitran/transpiler.ts

@@ -1,9 +1,18 @@
 import { defineBitranTranspiler } from '@bitran-js/transpiler';
+import {
+    setEruditBitranRuntime,
+    type EruditBitranRuntime,
+} from '@erudit-js/cog/schema';
 
 import getServerTranspilers from '#erudit/bitran/server';
 
-export async function createBitranTranspiler() {
+export async function createBitranTranspiler(runtime: EruditBitranRuntime) {
     const serverTranspiler = await getServerTranspilers();
     const bitranTranspiler = defineBitranTranspiler(serverTranspiler);
+
+    [bitranTranspiler.parser, bitranTranspiler.stringifier].forEach((item) => {
+        setEruditBitranRuntime(item, runtime);
+    });
+
     return bitranTranspiler;
 }

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

@@ -23,6 +23,7 @@ import { IMPORT } from '@server/importer';
 import { contributorExists } from '@server/repository/contributor';
 import { DbContribution } from '@server/db/entities/Contribution';
 import { DbFile } from '@server/db/entities/File';
+import { DbContentId } from '@server/db/entities/ContentId';
 
 import { contentAsset } from '@erudit/shared/asset';
 import type { ImageData } from '@erudit/shared/image';
@@ -83,9 +84,13 @@ async function addContentItem(navNode: NavNode) {
         `Adding ${stress(navNode.type)} content item ${stress(navNode.id)}...`,
     );
 
+    const dbContentId = new DbContentId();
+    dbContentId.fullId = navNode.fullId;
+    dbContentId.shortId = navNode.id;
+    await ERUDIT_SERVER.DB.manager.save(dbContentId);
+
     const dbContent = new DbContent();
-    dbContent.contentId = navNode.id;
-    dbContent.fullId = navNode.fullId;
+    dbContent.contentId = navNode.fullId;
     dbContent.type = navNode.type;
     dbContent.decoration = getDecoration(navNode);
     dbContent.ogImage = await getOgImageData(navNode);
@@ -134,7 +139,7 @@ async function addContributions(navNode: NavNode, contributors?: string[]) {
     if (!contributors || !contributors.length) {
         if (navNode.type !== 'book' && navNode.type !== 'group')
             logger.warn(
-                `${navNode.type.at(0)!.toUpperCase() + navNode.type.slice(1)} ${stress(navNode.id)} has no contributors!`,
+                `${navNode.type.at(0)!.toUpperCase() + navNode.type.slice(1)} ${stress(navNode.fullId)} has no contributors!`,
             );
 
         return;
@@ -143,13 +148,13 @@ async function addContributions(navNode: NavNode, contributors?: string[]) {
     for (const contributorId of contributors) {
         if (!(await contributorExists(contributorId))) {
             logger.warn(
-                `Skipping unknown contributor ${stress(contributorId)} when adding ${navNode.type} ${stress(navNode.id)}!`,
+                `Skipping unknown contributor ${stress(contributorId)} when adding ${navNode.type} ${stress(navNode.fullId)}!`,
             );
             continue;
         }
 
         const dbContribution = new DbContribution();
-        dbContribution.contentId = navNode.id;
+        dbContribution.contentId = navNode.fullId;
         dbContribution.contributorId = contributorId;
         await ERUDIT_SERVER.DB.manager.save(dbContribution);
     }

package/server/plugin/build/jobs/content/type/group.ts

@@ -12,7 +12,7 @@ export async function buildGroup({
     config,
 }: BuilderFunctionArgs<GroupConfig>) {
     const dbGroup = new DbGroup();
-    dbGroup.contentId = navNode.id;
+    dbGroup.contentId = navNode.fullId;
     dbGroup.type = config?.type || 'folder';
 
     try {
@@ -26,7 +26,7 @@ export async function buildGroup({
             await parseBitranContent(
                 {
                     type: 'group',
-                    path: navNode.id,
+                    path: dbGroup.contentId,
                 },
                 strContent,
             );

package/server/plugin/build/jobs/content/type/topic.ts

@@ -9,7 +9,7 @@ import { parseBitranContent } from '../parse';
 
 export async function buildTopic({ navNode }: BuilderFunctionArgs) {
     const dbTopic = new DbTopic();
-    dbTopic.contentId = navNode.id;
+    dbTopic.contentId = navNode.fullId;
     const existingTopicParts: TopicPart[] = [];
 
     for (const topicPart of topicParts) {
@@ -25,7 +25,7 @@ export async function buildTopic({ navNode }: BuilderFunctionArgs) {
         await parseBitranContent(
             {
                 type: topicPart,
-                path: navNode.id,
+                path: dbTopic.contentId,
             },
             strContent,
         );

package/server/plugin/build/jobs/nav.ts

@@ -1,6 +1,5 @@
 import { globSync } from 'glob';
 import chalk from 'chalk';
-import { resolvePaths } from '@erudit-js/cog/kit';
 import {
     contentTypes,
     topicParts,
@@ -54,13 +53,15 @@ async function scanChildNodes(
     parent: NavNode | RootNavNode,
     insideBook: boolean,
 ): Promise<{ children: NavNode[] | undefined; newIds: Ids }> {
-    const currentFsPath = isRootNode(parent) ? '' : parent.path;
+    const currentFsPath = isRootNode(parent) ? '' : parent.path + '/';
 
     const nodeFsPaths = globSync(
-        `${PROJECT_DIR}/content/${currentFsPath}/*/{${contentTypes.join(',')}}.{ts,js}`,
-    )
-        .sort()
-        .map((path) => resolvePaths(path));
+        `${currentFsPath}*/{${contentTypes.join(',')}}.{ts,js}`,
+        {
+            cwd: PROJECT_DIR + '/content',
+            posix: true,
+        },
+    ).sort();
 
     let newIds: Ids = {};
     const children: NavNode[] = [];
@@ -77,11 +78,7 @@ async function scanChildNodes(
 
         if (!pathParts) continue; // Wrong path pattern
 
-        const nodePath = nodeFsPath
-            .replace(PROJECT_DIR + '/content/', '')
-            .split('/')
-            .slice(0, -1)
-            .join('/');
+        const nodePath = nodeFsPath.split('/').slice(0, -1).join('/');
 
         if (pathParts.type === 'book' && insideBook) {
             logger.warn(

package/server/plugin/content/context.ts

@@ -9,6 +9,7 @@ import { ERUDIT_SERVER } from '@server/global';
 import { getIdsUp, isSkipId } from '@server/nav/utils';
 import { DbContent } from '@server/db/entities/Content';
 import { DbContributor } from '@server/db/entities/Contributor';
+import { getFullContentId } from '@server/repository/contentId';
 
 import type { Context } from '@shared/content/context';
 import {
@@ -19,6 +20,8 @@ import {
 import { CONTENT_TYPE_ICON, ICON, TOPIC_PART_ICON } from '@erudit/shared/icons';
 
 export async function getContentContext(contentId: string): Promise<Context> {
+    contentId = await getFullContentId(contentId);
+
     const context: Context = [];
 
     for (const _contentId of (await getIdsUp(contentId)).reverse()) {
@@ -106,7 +109,7 @@ export async function getLocationContext(
 
 async function getDbContent(contentId: string): Promise<DbContent> {
     const dbContent = await ERUDIT_SERVER.DB.manager.findOne(DbContent, {
-        select: ['type', 'title', 'fullId', 'contentId'],
+        select: ['type', 'title', 'contentId'],
         where: { contentId },
     });
 

package/server/plugin/db/entities/Content.ts

@@ -13,10 +13,6 @@ export class DbContent {
     @PrimaryColumn('varchar')
     contentId!: string;
 
-    @Column('varchar')
-    @Index({ unique: true })
-    fullId!: string;
-
     @Column('varchar')
     type!: ContentType;
 

package/server/plugin/db/entities/ContentId.ts

@@ -0,0 +1,11 @@
+import { Column, Entity, Index, PrimaryColumn } from 'typeorm';
+
+@Entity('contentId')
+export class DbContentId {
+    @PrimaryColumn('varchar')
+    fullId!: string;
+
+    @Column('varchar')
+    @Index({ unique: true })
+    shortId!: string;
+}

package/server/plugin/db/setup.ts

@@ -3,6 +3,7 @@ import { DataSource } from 'typeorm';
 
 import { PROJECT_DIR } from '#erudit/globalPaths';
 import { ERUDIT_SERVER } from '@server/global';
+import { logger } from '../logger';
 
 // Database Entities
 import { DbContributor } from './entities/Contributor';
@@ -14,7 +15,7 @@ import { DbHash } from './entities/Hash';
 import { DbTopic } from './entities/Topic';
 import { DbUnique } from './entities/Unique';
 import { DbFile } from './entities/File';
-import { logger } from '../logger';
+import { DbContentId } from './entities/ContentId';
 
 export async function setupDatabase() {
     rmSync(PROJECT_DIR + '/.erudit/data.sqlite', { force: true });
@@ -27,6 +28,7 @@ export async function setupDatabase() {
         dropSchema: true,
         entities: [
             DbBook,
+            DbContentId,
             DbContent,
             DbContribution,
             DbContributor,

package/server/plugin/importer.ts

@@ -1,10 +1,14 @@
 import { createJiti } from 'jiti';
-import { ERUDIT_DIR } from '#erudit/globalPaths';
+import { ERUDIT_DIR, PROJECT_DIR } from '#erudit/globalPaths';
 
 const jiti = createJiti(ERUDIT_DIR, {
     // Enable reimporting same files during process in development mode
     fsCache: !import.meta.dev,
     moduleCache: !import.meta.dev,
+    alias: {
+        '#project': PROJECT_DIR,
+        '#content': PROJECT_DIR + '/content',
+    },
 });
 
 export async function IMPORT(...args: Parameters<typeof jiti.import>) {