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

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

@@ -1,100 +1,113 @@
-import { ElementNode, walkForward } from '@bitran-js/core';
-import { type BitranTranspiler } from '@bitran-js/transpiler';
-import {
-    AliasesNode,
-    mergeAliases,
-    NO_ALIASES,
-} from '@erudit-js/bitran-elements/aliases/shared';
-import { HeadingNode } from '@erudit-js/bitran-elements/heading/shared';
-
-import { createBitranTranspiler } from '@server/bitran/transpiler';
-import { ERUDIT_SERVER } from '@server/global';
-import { DbUnique } from '@server/db/entities/Unique';
-
-import type { BitranContext } from '@shared/bitran/context';
-import {
-    stringifyBitranLocation,
-    type BitranLocation,
-} from '@shared/bitran/location';
-
-let context: BitranContext = {} as any;
-let bitranTranspiler: BitranTranspiler;
-
-const blocksAfterHeading = 2;
-
-export async function parseBitranContent(
-    location: BitranLocation,
-    biCode: string,
-) {
-    // Reset Bitran context in order not to create core each time
-    context.location = location;
-    context.aliases = NO_ALIASES();
-
-    bitranTranspiler ||= await createBitranTranspiler();
-
-    // Tracking heading nodes to deal with them later
-    const headings: HeadingNode[] = [];
-
-    await bitranTranspiler.parser.parse(biCode, {
-        async step(node) {
-            const meta = node.meta;
-            const uniqueId = meta?.id;
-
-            if (node instanceof AliasesNode) {
-                mergeAliases(context.aliases, node.parseData);
-            }
-
-            if (uniqueId) {
-                if (node instanceof HeadingNode) {
-                    headings.push(node);
-                    return;
-                }
-
-                await addUnique(node);
-            }
-        },
-    });
-
-    for (const heading of headings) {
-        let blocksAfter = 0;
-        let content = await bitranTranspiler.stringifier.stringify(heading);
-
-        await walkForward(heading, async (node) => {
-            if (blocksAfter >= blocksAfterHeading) return false;
-
-            if (node instanceof AliasesNode) return;
-            // Spoiler
-            // Todo
-
-            content +=
-                '\n\n' + (await bitranTranspiler.stringifier.stringify(node));
-
-            blocksAfter++;
-        });
-
-        await addUnique(heading, content);
-    }
-
-    //
-    //
-    //
-
-    function createUniqueLocation(node: ElementNode) {
-        return stringifyBitranLocation({
-            ...location,
-            ...{ unique: node.meta.id! },
-        });
-    }
-
-    async function addUnique(node: ElementNode, content?: string) {
-        const dbUnique = new DbUnique();
-        dbUnique.location = createUniqueLocation(node);
-        dbUnique.content =
-            content || (await bitranTranspiler.stringifier.stringify(node));
-        dbUnique.title = node.parseData?.title || node.meta?.title;
-        dbUnique.productName = node.name;
-        dbUnique.context = context;
-
-        await ERUDIT_SERVER.DB.manager.save(dbUnique);
-    }
-}
+import { ElementNode, walkForward } from '@bitran-js/core';
+import { type BitranTranspiler } from '@bitran-js/transpiler';
+
+import {
+    mergeAliases,
+    NO_ALIASES,
+    stringifyBitranLocation,
+    type BitranContext,
+    type BitranLocation,
+} from '@erudit-js/cog/schema';
+import { AliasesNode } from '@erudit-js/bitran-elements/aliases/shared';
+import { DetailsNode } from '@erudit-js/bitran-elements/details/shared';
+import { HeadingNode } from '@erudit-js/bitran-elements/heading/shared';
+
+import { createBitranTranspiler } from '@server/bitran/transpiler';
+import { ERUDIT_SERVER } from '@server/global';
+import { DbUnique } from '@server/db/entities/Unique';
+
+let context: BitranContext = {} as any;
+let bitranTranspiler: BitranTranspiler;
+
+const blocksAfterHeading = 2;
+
+export async function parseBitranContent(
+    location: BitranLocation,
+    biCode: string,
+) {
+    // Reset Bitran context in order not to create core each time
+    context.location = location;
+    context.aliases = NO_ALIASES();
+
+    bitranTranspiler ||= await createBitranTranspiler({
+        context,
+        eruditConfig: ERUDIT_SERVER.CONFIG,
+        insideInclude: false,
+    });
+
+    // Tracking heading nodes to deal with them later
+    const headings: HeadingNode[] = [];
+
+    await bitranTranspiler.parser.parse(biCode, {
+        async step(node) {
+            const meta = node.meta;
+            const uniqueId = meta?.id;
+
+            if (node instanceof AliasesNode) {
+                mergeAliases(context.aliases, node.parseData);
+            }
+
+            if (uniqueId) {
+                if (node instanceof HeadingNode) {
+                    headings.push(node);
+                    return;
+                }
+
+                if (node instanceof DetailsNode) {
+                    await addUnique(
+                        node,
+                        await bitranTranspiler.stringifier.stringify(
+                            node.parseData,
+                        ),
+                    );
+                    return;
+                }
+
+                await addUnique(node);
+            }
+        },
+    });
+
+    for (const heading of headings) {
+        let blocksAfter = 0;
+        let content = await bitranTranspiler.stringifier.stringify(heading);
+
+        await walkForward(heading, async (node) => {
+            if (blocksAfter >= blocksAfterHeading) return false;
+
+            if (node instanceof AliasesNode) return;
+            if (node instanceof DetailsNode) return;
+            // Todo
+
+            content +=
+                '\n\n' + (await bitranTranspiler.stringifier.stringify(node));
+
+            blocksAfter++;
+        });
+
+        await addUnique(heading, content);
+    }
+
+    //
+    //
+    //
+
+    function createUniqueLocation(node: ElementNode) {
+        return stringifyBitranLocation({
+            ...location,
+            ...{ unique: node.meta.id! },
+        });
+    }
+
+    async function addUnique(node: ElementNode, content?: string) {
+        const dbUnique = new DbUnique();
+        dbUnique.location = createUniqueLocation(node);
+        dbUnique.content =
+            content || (await bitranTranspiler.stringifier.stringify(node));
+        dbUnique.title = node.parseData?.title || node.meta?.title || null;
+        dbUnique.productName = node.name;
+        dbUnique.context = context;
+
+        await ERUDIT_SERVER.DB.manager.save(dbUnique);
+    }
+}

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

@@ -1,6 +1,6 @@
-import { PROJECT_DIR } from '#erudit/globalPaths';
-import type { NavNode } from '@server/nav/node';
-
-export function contentItemPath(navNode: NavNode, path?: string) {
-    return PROJECT_DIR + `/content/${navNode.path}${path ? '/' + path : ''}`;
-}
+import { PROJECT_DIR } from '#erudit/globalPaths';
+import type { NavNode } from '@server/nav/node';
+
+export function contentItemPath(navNode: NavNode, path?: string) {
+    return PROJECT_DIR + `/content/${navNode.fsPath}${path ? '/' + path : ''}`;
+}

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

@@ -1,9 +1,9 @@
-import { DbBook } from '@server/db/entities/Book';
-import { ERUDIT_SERVER } from '@server/global';
-import type { BuilderFunctionArgs } from '../builderArgs';
-
-export async function buildBook({ dbContent }: BuilderFunctionArgs) {
-    const dbBook = new DbBook();
-    dbBook.contentId = dbContent.contentId;
-    await ERUDIT_SERVER.DB.manager.save(dbBook);
-}
+import { DbBook } from '@server/db/entities/Book';
+import { ERUDIT_SERVER } from '@server/global';
+import type { BuilderFunctionArgs } from '../builderArgs';
+
+export async function buildBook({ dbContent }: BuilderFunctionArgs) {
+    const dbBook = new DbBook();
+    dbBook.contentId = dbContent.contentId;
+    await ERUDIT_SERVER.DB.manager.save(dbBook);
+}

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

@@ -1,37 +1,37 @@
-import { readFileSync } from 'node:fs';
-import type { GroupConfig } from 'erudit-cog/schema';
-
-import { DbGroup } from '@server/db/entities/Group';
-import { ERUDIT_SERVER } from '@erudit/server/plugin/global';
-import type { BuilderFunctionArgs } from '../builderArgs';
-import { contentItemPath } from '../path';
-import { parseBitranContent } from '../parse';
-
-export async function buildGroup({
-    navNode,
-    config,
-}: BuilderFunctionArgs<GroupConfig>) {
-    const dbGroup = new DbGroup();
-    dbGroup.contentId = navNode.id;
-    dbGroup.type = config?.type || 'folder';
-
-    try {
-        const strContent = readFileSync(
-            contentItemPath(navNode, 'content.bi'),
-            'utf-8',
-        );
-
-        if (strContent) {
-            dbGroup.content = strContent;
-            await parseBitranContent(
-                {
-                    type: 'group',
-                    path: navNode.id,
-                },
-                strContent,
-            );
-        }
-    } catch {}
-
-    await ERUDIT_SERVER.DB.manager.save(dbGroup);
-}
+import { readFileSync } from 'node:fs';
+import type { GroupConfig } from '@erudit-js/cog/schema';
+
+import { DbGroup } from '@server/db/entities/Group';
+import { ERUDIT_SERVER } from '@erudit/server/plugin/global';
+import type { BuilderFunctionArgs } from '../builderArgs';
+import { contentItemPath } from '../path';
+import { parseBitranContent } from '../parse';
+
+export async function buildGroup({
+    navNode,
+    config,
+}: BuilderFunctionArgs<GroupConfig>) {
+    const dbGroup = new DbGroup();
+    dbGroup.contentId = navNode.fullId;
+    dbGroup.type = config?.type || 'folder';
+
+    try {
+        const strContent = readFileSync(
+            contentItemPath(navNode, 'content.bi'),
+            'utf-8',
+        );
+
+        if (strContent) {
+            dbGroup.content = strContent;
+            await parseBitranContent(
+                {
+                    type: 'group',
+                    path: dbGroup.contentId,
+                },
+                strContent,
+            );
+        }
+    } catch {}
+
+    await ERUDIT_SERVER.DB.manager.save(dbGroup);
+}

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

@@ -1,36 +1,36 @@
-import { existsSync, readFileSync } from 'node:fs';
-import { topicParts, type TopicPart } from 'erudit-cog/schema';
-
-import { ERUDIT_SERVER } from '@server/global';
-import { DbTopic } from '@server/db/entities/Topic';
-import type { BuilderFunctionArgs } from '../builderArgs';
-import { contentItemPath } from '../path';
-import { parseBitranContent } from '../parse';
-
-export async function buildTopic({ navNode }: BuilderFunctionArgs) {
-    const dbTopic = new DbTopic();
-    dbTopic.contentId = navNode.id;
-    const existingTopicParts: TopicPart[] = [];
-
-    for (const topicPart of topicParts) {
-        const partPath = contentItemPath(navNode, `${topicPart}.bi`);
-        const strContent =
-            existsSync(partPath) && readFileSync(partPath, 'utf-8');
-
-        if (strContent === false) continue;
-
-        existingTopicParts.push(topicPart);
-        dbTopic[topicPart] = strContent;
-
-        await parseBitranContent(
-            {
-                type: topicPart,
-                path: navNode.id,
-            },
-            strContent,
-        );
-    }
-
-    dbTopic.parts = existingTopicParts;
-    await ERUDIT_SERVER.DB.manager.save(dbTopic);
-}
+import { existsSync, readFileSync } from 'node:fs';
+import { topicParts, type TopicPart } from '@erudit-js/cog/schema';
+
+import { ERUDIT_SERVER } from '@server/global';
+import { DbTopic } from '@server/db/entities/Topic';
+import type { BuilderFunctionArgs } from '../builderArgs';
+import { contentItemPath } from '../path';
+import { parseBitranContent } from '../parse';
+
+export async function buildTopic({ navNode }: BuilderFunctionArgs) {
+    const dbTopic = new DbTopic();
+    dbTopic.contentId = navNode.fullId;
+    const existingTopicParts: TopicPart[] = [];
+
+    for (const topicPart of topicParts) {
+        const partPath = contentItemPath(navNode, `${topicPart}.bi`);
+        const strContent =
+            existsSync(partPath) && readFileSync(partPath, 'utf-8');
+
+        if (strContent === false) continue;
+
+        existingTopicParts.push(topicPart);
+        dbTopic[topicPart] = strContent;
+
+        await parseBitranContent(
+            {
+                type: topicPart,
+                path: dbTopic.contentId,
+            },
+            strContent,
+        );
+    }
+
+    dbTopic.parts = existingTopicParts;
+    await ERUDIT_SERVER.DB.manager.save(dbTopic);
+}

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

@@ -1,66 +1,69 @@
-import { readFileSync } from 'node:fs';
-import { globSync } from 'glob';
-import path from 'node:path';
-import chalk from 'chalk';
-import { resolvePaths } from 'erudit-cog/kit';
-import type { ContributorConfig } from 'erudit-cog/schema';
-
-import { PROJECT_DIR } from '#erudit/globalPaths';
-import { stress } from '@erudit/utils/stress';
-import { debug, logger } from '@server/logger';
-import { ERUDIT_SERVER } from '@server/global';
-import { IMPORT } from '@server/importer';
-import { DbContributor } from '@server/db/entities/Contributor';
-
-export async function buildContributors() {
-    debug.start('Building contributors...');
-
-    const contributorPaths = globSync(PROJECT_DIR + '/contributors/*/');
-    for (const contributorPath of contributorPaths)
-        await addContributor(resolvePaths(contributorPath));
-
-    logger.success(
-        `Contributors built successfully!`,
-        chalk.dim(`(${contributorPaths.length})`),
-    );
-}
-
-async function addContributor(contributorPath: string) {
-    const contributorId = contributorPath.split('/').pop() as string;
-
-    debug.start(`Adding contributor ${stress(contributorId)}...`);
-
-    const avatarFilename = (() => {
-        const avatarPaths = globSync(`${contributorPath}/avatar.*`);
-        if (avatarPaths[0])
-            return avatarPaths[0].split(path.sep).slice(-2).join('/');
-
-        return undefined;
-    })();
-
-    const config: Partial<ContributorConfig> = await (async () => {
-        try {
-            return await IMPORT(`${contributorPath}/contributor`, {
-                default: true,
-            });
-        } catch {
-            return {};
-        }
-    })();
-
-    const description = (() => {
-        try {
-            return readFileSync(`${contributorPath}/description.bi`, 'utf-8');
-        } catch {
-            return undefined;
-        }
-    })();
-
-    const dbContributor = new DbContributor();
-    dbContributor.contributorId = contributorId;
-    dbContributor.avatar = avatarFilename;
-    dbContributor.displayName = config.displayName;
-    dbContributor.description = description;
-
-    await ERUDIT_SERVER.DB.manager.save(dbContributor);
-}
+import { readFileSync } from 'node:fs';
+import { globSync } from 'glob';
+import path from 'node:path';
+import chalk from 'chalk';
+import { resolvePaths } from '@erudit-js/cog/kit';
+import type { ContributorConfig } from '@erudit-js/cog/schema';
+
+import { PROJECT_DIR } from '#erudit/globalPaths';
+import { stress } from '@erudit/utils/stress';
+import { debug, logger } from '@server/logger';
+import { ERUDIT_SERVER } from '@server/global';
+import { IMPORT } from '@server/importer';
+import { DbContributor } from '@server/db/entities/Contributor';
+
+export async function buildContributors() {
+    debug.start('Building contributors...');
+
+    const contributorPaths = globSync(PROJECT_DIR + '/contributors/*/');
+    for (const contributorPath of contributorPaths)
+        await addContributor(resolvePaths(contributorPath));
+
+    logger.success(
+        `Contributors built successfully!`,
+        chalk.dim(`(${contributorPaths.length})`),
+    );
+}
+
+async function addContributor(contributorPath: string) {
+    const contributorId = contributorPath.split('/').pop() as string;
+
+    debug.start(`Adding contributor ${stress(contributorId)}...`);
+
+    const avatarFilename = (() => {
+        const avatarPaths = globSync(`${contributorPath}/avatar.*`);
+        if (avatarPaths[0])
+            return avatarPaths[0].split(path.sep).slice(-2).join('/');
+
+        return undefined;
+    })();
+
+    const config: Partial<ContributorConfig> = await (async () => {
+        try {
+            return await IMPORT(`${contributorPath}/contributor`, {
+                default: true,
+            });
+        } catch {
+            return {};
+        }
+    })();
+
+    const description = (() => {
+        try {
+            return readFileSync(`${contributorPath}/description.bi`, 'utf-8');
+        } catch {
+            return undefined;
+        }
+    })();
+
+    const dbContributor = new DbContributor();
+    dbContributor.contributorId = contributorId;
+    dbContributor.avatar = avatarFilename;
+    dbContributor.displayName = config.displayName;
+    dbContributor.isEditor = Boolean(config.editor);
+    dbContributor.slogan = config.slogan;
+    dbContributor.links = config.links;
+    dbContributor.description = description;
+
+    await ERUDIT_SERVER.DB.manager.save(dbContributor);
+}

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

@@ -1,36 +1,36 @@
-import { existsSync } from 'node:fs';
-
-import { ERUDIT_DIR } from '#erudit/globalPaths';
-import { stress } from '@erudit/utils/stress';
-import { ERUDIT_SERVER } from '@server/global';
-import { IMPORT } from '@server/importer';
-
-export async function setupLanguage() {
-    const languageCode = ERUDIT_SERVER.CONFIG?.language || 'en';
-    const languageFilePath = ERUDIT_DIR + `/languages/${languageCode}.ts`;
-
-    if (!existsSync(languageFilePath))
-        throw new Error(`Language file for ${stress(languageCode)} not found!`);
-
-    try {
-        const languageModule = await IMPORT(languageFilePath);
-
-        if (!languageModule.default)
-            throw new Error(
-                `Language file for ${stress(languageCode)} is missing default export with phrases!`,
-            );
-
-        const { default: phrases, ...context } = { ...languageModule };
-
-        ERUDIT_SERVER.LANGUAGE = {
-            phrases,
-            functions: Object.entries(context)
-                .filter(([, value]) => typeof value === 'function')
-                .reduce((acc, [key, value]) => ({ ...acc, [key]: value }), {}),
-        };
-    } catch (error) {
-        throw new Error(
-            `Error while loading language ${stress(languageCode)}!\n\n${error}`,
-        );
-    }
-}
+import { existsSync } from 'node:fs';
+
+import { ERUDIT_DIR } from '#erudit/globalPaths';
+import { stress } from '@erudit/utils/stress';
+import { ERUDIT_SERVER } from '@server/global';
+import { IMPORT } from '@server/importer';
+
+export async function setupLanguage() {
+    const languageCode = ERUDIT_SERVER.CONFIG?.language || 'en';
+    const languageFilePath = ERUDIT_DIR + `/languages/${languageCode}.ts`;
+
+    if (!existsSync(languageFilePath))
+        throw new Error(`Language file for ${stress(languageCode)} not found!`);
+
+    try {
+        const languageModule = await IMPORT(languageFilePath);
+
+        if (!languageModule.default)
+            throw new Error(
+                `Language file for ${stress(languageCode)} is missing default export with phrases!`,
+            );
+
+        const { default: phrases, ...context } = { ...languageModule };
+
+        ERUDIT_SERVER.LANGUAGE = {
+            phrases,
+            functions: Object.entries(context)
+                .filter(([, value]) => typeof value === 'function')
+                .reduce((acc, [key, value]) => ({ ...acc, [key]: value }), {}),
+        };
+    } catch (error) {
+        throw new Error(
+            `Error while loading language ${stress(languageCode)}!\n\n${error}`,
+        );
+    }
+}