erudit 3.0.0-dev.23 → 3.0.0-dev.26

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

@@ -1,345 +0,0 @@
-import { globSync } from 'glob';
-import chalk from 'chalk';
-import { readFileSync, writeFileSync, existsSync } from 'fs';
-import { join } from 'path';
-import {
-    contentTypes,
-    topicParts,
-    type ContentType,
-} from '@erudit-js/cog/schema';
-
-import { PROJECT_DIR } from '#erudit/globalPaths';
-import { stress } from '@erudit/utils/stress';
-import { debug, logger } from '@server/logger';
-import {
-    createRootNode,
-    isRootNode,
-    type NavNode,
-    type RootNavNode,
-} from '@server/nav/node';
-import { ERUDIT_SERVER } from '@server/global';
-import { jiti } from '@server/importer';
-
-type Ids = Record<string, string>;
-let fullIds: Ids;
-
-const nodePathRegexp = new RegExp(
-    `(?<pos>\\d+)(?<sep>-|\\+)(?<id>[\\w-]+)\\/(?<type>${contentTypes.join('|')})\\..*`,
-);
-
-const contentFilter = createContentFilter();
-
-export async function buildNav() {
-    debug.start('Building navigation tree...');
-
-    fullIds = {};
-
-    const rootNode = createRootNode();
-    rootNode.children = (await scanChildNodes(rootNode, false)).children;
-    ERUDIT_SERVER.NAV = rootNode.children ? rootNode : undefined;
-
-    const nodeCount = Object.values(fullIds).length;
-
-    if (nodeCount === 0) {
-        logger.warn('No content nodes detected! The site will be empty!');
-    } else {
-        if (ERUDIT_SERVER.CONFIG?.debug?.log) debugPrintNav(rootNode);
-
-        writeCompilerOptionsPaths();
-        writeJitiAliases();
-
-        logger.success(
-            'Navigation tree built successfully!',
-            chalk.dim(`(${nodeCount})`),
-        );
-    }
-}
-
-async function scanChildNodes(
-    parent: NavNode | RootNavNode,
-    insideBook: boolean,
-): Promise<{ children: NavNode[] | undefined; newIds: Ids }> {
-    const currentFsPath = isRootNode(parent) ? '' : parent.fsPath + '/';
-
-    const nodeFsPaths = globSync(
-        `${currentFsPath}*/{${contentTypes.join(',')}}.{ts,js}`,
-        {
-            cwd: PROJECT_DIR + '/content',
-            posix: true,
-        },
-    ).sort();
-
-    let newIds: Ids = {};
-    const children: NavNode[] = [];
-
-    for (const nodeFsPath of nodeFsPaths) {
-        const pathParts:
-            | {
-                  pos: string;
-                  sep: string;
-                  id: string;
-                  type: ContentType;
-              }
-            | undefined = nodeFsPath.match(nodePathRegexp)?.groups as any;
-
-        if (!pathParts) continue; // Wrong path pattern
-
-        const nodePath = nodeFsPath.split('/').slice(0, -1).join('/');
-
-        if (pathParts.type === 'book' && insideBook) {
-            logger.warn(
-                'Books inside books are not allowed!\n',
-                `Skipping ${stress(nodePath)} nav node!`,
-            );
-            continue;
-        }
-
-        const parentId = isRootNode(parent)
-            ? ''
-            : parent.skip
-              ? parent.fullId.split('/').slice(0, -1).join('/')
-              : parent.fullId;
-
-        // Regular id might not include parent id part if it is skipped
-        const id = parentId ? `${parentId}/${pathParts.id}` : pathParts.id;
-
-        if (fullIds[id]) {
-            logger.warn(
-                `Nav node ${stress(id)} ID collision!\n\n`,
-                `This ID belongs to ${stress(fullIds[id], chalk.greenBright)} nav node.\n`,
-                `Nav node ${stress(nodePath, chalk.redBright)} tries to use the same ID!\n`,
-                'Skipping nav node which causes collision!',
-            );
-            continue;
-        }
-
-        // Full id always includes parent id
-        const fullId = isRootNode(parent)
-            ? pathParts.id
-            : `${parent.fullId}/${pathParts.id}`;
-
-        // Short id skips parent ids for nodes with skip=true, except current node
-        const shortId = isRootNode(parent)
-            ? pathParts.id
-            : (() => {
-                  // Traverse up, skipping parent ids where skip=true
-                  let ids: string[] = [];
-                  let p: NavNode | RootNavNode | undefined = parent;
-                  while (p && !isRootNode(p)) {
-                      if (!p.skip) ids.unshift(p.idPart);
-                      p = p.parent;
-                  }
-                  ids.push(pathParts.id);
-                  return ids.join('/');
-              })();
-
-        const shouldSkip = (() => {
-            const targets = [
-                ...contentFilter.cliContentTargets,
-                ...(ERUDIT_SERVER.CONFIG?.contentTargets || []),
-            ];
-
-            // If there are no filters, allow all nodes
-            if (targets.length === 0) {
-                return false;
-            }
-
-            // If the node passes at least one filter, keep it
-            for (const target of targets) {
-                if (contentFilter.strFilter(fullId, target)) {
-                    return false;
-                }
-            }
-
-            // Node failed all filters, skip it
-            return true;
-        })();
-
-        if (shouldSkip) continue;
-
-        const skip = pathParts.sep === '+';
-
-        const childNode: NavNode = {
-            parent,
-            type: pathParts.type,
-            fsPath: nodePath,
-            idPart: pathParts.id,
-            fullId,
-            shortId,
-            skip,
-        };
-
-        if (!validNode(childNode)) continue;
-
-        fullIds[fullId] = nodePath;
-        newIds[fullId] = nodePath;
-
-        const scanResult = await scanChildNodes(
-            childNode,
-            insideBook || childNode.type === 'book',
-        );
-
-        if (
-            ['book', 'group'].includes(childNode.type) &&
-            !scanResult.children
-        ) {
-            delete fullIds[fullId];
-            delete newIds[fullId];
-            for (const childNewId of Object.keys(scanResult.newIds))
-                delete fullIds[childNewId];
-            continue;
-        }
-
-        if (childNode.type === 'book') {
-            ERUDIT_SERVER.NAV_BOOKS ||= {};
-            ERUDIT_SERVER.NAV_BOOKS[fullId] = childNode;
-        }
-
-        childNode.children = scanResult.children;
-        children.push(childNode);
-    }
-
-    return {
-        children: children.length > 0 ? children : undefined,
-        newIds,
-    };
-}
-
-function createContentFilter() {
-    const cliContentTargets = (() => {
-        try {
-            return JSON.parse(
-                readFileSync(PROJECT_DIR + '/.erudit/targets.json', 'utf-8'),
-            );
-        } catch (error) {}
-
-        return [];
-    })();
-
-    const strFilter = (fullId: string, filterItem: string) => {
-        if (fullId.startsWith(filterItem) || filterItem.search(fullId) === 0) {
-            return true;
-        }
-
-        return false;
-    };
-
-    return {
-        cliContentTargets,
-        strFilter,
-    };
-}
-
-function validNode(node: NavNode): boolean {
-    switch (node.type) {
-        case 'topic':
-            const partPaths = globSync(
-                PROJECT_DIR +
-                    `/content/${node.fsPath}` +
-                    `/{${topicParts.join(',')}}.bi`,
-            );
-            if (partPaths.length === 0) return false; // Topic is empty
-            break;
-        case 'book':
-            if (node.skip) {
-                logger.warn(
-                    `Books can't skip their ID part!\n`,
-                    `Skipping ${stress(node.fsPath)} nav node!`,
-                );
-                return false;
-            }
-            break;
-    }
-
-    return true;
-}
-
-function debugPrintNav(node: RootNavNode) {
-    const logNode = (node: NavNode | RootNavNode, indent: number) => {
-        console.log(
-            isRootNode(node)
-                ? chalk.dim('#root')
-                : `${'  '.repeat(indent)}${node.idPart} ${chalk.dim(`[${node.type}${node.skip ? ', ' + chalk.yellow('skip') : ''}]`)}`,
-        );
-
-        if (node.children)
-            for (const child of node.children) logNode(child, indent + 1);
-    };
-
-    logNode(node, 0);
-}
-
-function writeCompilerOptionsPaths() {
-    const tsconfigPath = `${PROJECT_DIR}/.erudit/tsconfig.json`;
-
-    try {
-        let tsconfig: any = {};
-
-        if (existsSync(tsconfigPath)) {
-            try {
-                tsconfig = JSON.parse(readFileSync(tsconfigPath, 'utf8'));
-            } catch (err) {
-                logger.warn(
-                    `Error parsing ${tsconfigPath}, creating a new one.`,
-                );
-            }
-        }
-
-        tsconfig.compilerOptions = tsconfig.compilerOptions || {};
-        tsconfig.compilerOptions.paths = tsconfig.compilerOptions.paths || {};
-
-        const paths = tsconfig.compilerOptions.paths;
-
-        Object.keys(paths).forEach((key) => {
-            if (key === '#content/*') {
-                return;
-            }
-
-            if (key.startsWith('#content/')) {
-                delete paths[key];
-            }
-        });
-
-        Object.entries(fullIds).forEach(([id, fsPath]) => {
-            const pathKey = `#content/${id}/*`;
-            paths[pathKey] = [`../content/${fsPath}/*`];
-        });
-
-        writeFileSync(tsconfigPath, JSON.stringify(tsconfig, null, 4), 'utf8');
-        logger.success(`Updated tsconfig content paths!`);
-    } catch (_error) {
-        logger.error(`Failed to write compiler paths: ${_error}`);
-    }
-}
-
-function writeJitiAliases() {
-    try {
-        if (!jiti.options) {
-            jiti.options = {};
-        }
-
-        if (!jiti.options.alias) {
-            jiti.options.alias = {};
-        }
-
-        const aliases = jiti.options.alias;
-
-        Object.keys(aliases).forEach((key) => {
-            if (key === '#content/*') {
-                return;
-            }
-
-            if (key.startsWith('#content/')) {
-                delete aliases[key];
-            }
-        });
-
-        Object.entries(fullIds).forEach(([id, fsPath]) => {
-            aliases[`#content/${id}`] = `${PROJECT_DIR}/content/${fsPath}`;
-        });
-
-        logger.success('Updated jiti content aliases!');
-    } catch (_error) {
-        logger.error(`Failed to write jiti aliases: ${_error}`);
-    }
-}

package/server/plugin/build/process.ts

@@ -1,34 +0,0 @@
-import { resetDatabase } from '@server/db/reset';
-import { ERUDIT_SERVER } from '@server/global';
-import { debug, logger } from '@server/logger';
-
-import { setup } from './setup';
-import { setupLanguage } from './jobs/language';
-import { buildContributors } from './jobs/contributors';
-import { buildNav } from './jobs/nav';
-import { buildContent } from './jobs/content/generic';
-import { buildSponsors } from '@server/sponsor/build';
-
-let initial = true;
-
-async function _build() {
-    debug.start('Building data...');
-
-    if (initial) {
-        await setup();
-        initial = false;
-    }
-
-    await resetDatabase();
-    await setupLanguage();
-    await buildContributors();
-    await buildNav();
-    await buildContent();
-    await buildSponsors();
-
-    logger.success('Build successful!');
-}
-
-export async function build() {
-    ERUDIT_SERVER.BUILD_PROMISE = _build();
-}

package/server/plugin/build/rebuild.ts

@@ -1,68 +0,0 @@
-import chokidar, { type FSWatcher } from 'chokidar';
-
-import { ERUDIT_DIR, PROJECT_DIR } from '#erudit/globalPaths';
-import { ERUDIT_SERVER } from '@server/global';
-import { logger } from '@server/logger';
-import { build } from '@server/build/process';
-import { stress } from '@erudit/utils/stress';
-
-const watchTargets: string[] = [
-    // Languages
-    ERUDIT_DIR + '/languages',
-    // Content directory
-    PROJECT_DIR + '/content',
-    // Contributors directory
-    PROJECT_DIR + '/contributors',
-    // Sponsors directory
-    PROJECT_DIR + '/sponsors',
-];
-
-const ignoreTargets: string[] = [];
-
-const rebuildDelay = 300;
-
-//
-//
-//
-
-let watcher: FSWatcher;
-let rebuildTimeout: any;
-let rebuildRequested = false;
-let pendingRebuild = false;
-
-export async function setupRebuildWatcher() {
-    if (watcher) return;
-
-    watcher = chokidar.watch(watchTargets, {
-        ignored: ignoreTargets,
-        ignoreInitial: true,
-    });
-
-    watcher.on('all', (event, path) =>
-        requestServerRebuild(`File change: ${stress(path)}`),
-    );
-}
-
-export async function requestServerRebuild(reason?: string) {
-    // If rebuild is in progress, set flag for another rebuild after completion
-    if (rebuildRequested) {
-        pendingRebuild = true;
-        return;
-    }
-
-    clearTimeout(rebuildTimeout);
-    rebuildTimeout = setTimeout(async () => {
-        rebuildRequested = true;
-        await ERUDIT_SERVER.BUILD_PROMISE;
-        console.log('\n');
-        logger.info(`Rebuilding server data!${reason ? ` ${reason}` : ''}\n\n`);
-        await build();
-        rebuildRequested = false;
-
-        // If changes were detected during rebuild, start another rebuild
-        if (pendingRebuild) {
-            pendingRebuild = false;
-            requestServerRebuild('Changes detected during previous rebuild');
-        }
-    }, rebuildDelay);
-}

package/server/plugin/build/setup.ts

@@ -1,19 +0,0 @@
-import eruditConfig from '#erudit/config';
-
-import { registerGlobals } from '@erudit/globals/register';
-import { debug } from '@server/logger';
-import { ERUDIT_SERVER } from '@server/global';
-
-import { setupRebuildWatcher } from './rebuild';
-import { setupDatabase } from '../db/setup';
-
-export async function setup() {
-    debug.start('Running initial setup procedures...');
-
-    if (import.meta.dev) await setupRebuildWatcher();
-
-    registerGlobals();
-    ERUDIT_SERVER.CONFIG = eruditConfig;
-
-    await setupDatabase();
-}

package/server/plugin/content/context.ts

@@ -1,116 +0,0 @@
-import {
-    isContentType,
-    isTopicPart,
-    type BitranLocation,
-    type TopicPart,
-} from '@erudit-js/cog/schema';
-
-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 { createContributorLink, createTopicPartLink } from '@shared/link';
-import { createContentLink } from '@server/repository/link';
-import { CONTENT_TYPE_ICON, ICON, TOPIC_PART_ICON } from '@erudit/shared/icons';
-
-export async function getContentContext(contentId: string): Promise<Context> {
-    contentId = getFullContentId(contentId);
-
-    const context: Context = [];
-
-    for (const _contentId of getIdsUp(contentId).reverse()) {
-        const dbContent = await getDbContent(_contentId);
-
-        context.push({
-            type: ERUDIT_SERVER.LANGUAGE.phrases[dbContent.type],
-            icon: isTopicPart(dbContent.type)
-                ? TOPIC_PART_ICON[dbContent.type]
-                : isContentType(dbContent.type)
-                  ? CONTENT_TYPE_ICON[dbContent.type]
-                  : '',
-            title: dbContent.title || dbContent.contentId,
-            href: await createContentLink(dbContent.contentId),
-            hidden: await isSkipId(dbContent.contentId),
-        });
-    }
-
-    return context;
-}
-
-export async function getTopicPartContext(
-    topicPart: TopicPart,
-    contentId: string,
-): Promise<Context> {
-    const context = await getContentContext(contentId);
-    const topicItem = context.pop()!;
-
-    topicItem.type = ERUDIT_SERVER.LANGUAGE.phrases[topicPart];
-    topicItem.icon = TOPIC_PART_ICON[topicPart];
-    topicItem.href = createTopicPartLink(topicPart, contentId);
-
-    return context.concat([topicItem]);
-}
-
-export async function getContributorContext(
-    contributorId: string,
-): Promise<Context> {
-    const dbContributor = await ERUDIT_SERVER.DB.manager.findOne(
-        DbContributor,
-        {
-            select: ['displayName'],
-            where: { contributorId },
-        },
-    );
-
-    if (!dbContributor)
-        throw new Error(`Contributor "${contributorId}" not found!`);
-
-    return [
-        {
-            type: ERUDIT_SERVER.LANGUAGE.phrases.contributor,
-            icon: ICON.contributor,
-            title: dbContributor.displayName || contributorId,
-            href: createContributorLink(contributorId),
-            hidden: false,
-        },
-    ];
-}
-
-export async function getLocationContext(
-    location: BitranLocation,
-): Promise<Context> {
-    const contentId = location.path!;
-
-    switch (location.type) {
-        case 'article':
-        case 'summary':
-        case 'practice':
-            return await getTopicPartContext(location.type, contentId);
-        case 'group':
-            return await getContentContext(contentId);
-        case 'contributor':
-            return await getContributorContext(contentId);
-    }
-
-    throw new Error(
-        `Cant' build context for location unknown type "${location.type}"!`,
-    );
-}
-
-//
-//
-//
-
-async function getDbContent(contentId: string): Promise<DbContent> {
-    const dbContent = await ERUDIT_SERVER.DB.manager.findOne(DbContent, {
-        select: ['type', 'title', 'contentId'],
-        where: { contentId },
-    });
-
-    if (!dbContent) throw new Error(`Content "${contentId}" not found!`);
-
-    return dbContent;
-}

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

@@ -1,7 +0,0 @@
-import { Entity, PrimaryColumn } from 'typeorm';
-
-@Entity('book')
-export class DbBook {
-    @PrimaryColumn('varchar')
-    contentId!: string;
-}

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

@@ -1,45 +0,0 @@
-import { Column, Entity, Index, PrimaryColumn } from 'typeorm';
-import type {
-    ContentFlag,
-    ContentReferences,
-    ContentSeo,
-    ContentType,
-} from '@erudit-js/cog/schema';
-
-import type { ImageData } from '@erudit/shared/image';
-
-@Entity('content')
-export class DbContent {
-    @PrimaryColumn('varchar')
-    contentId!: string;
-
-    @Column('varchar')
-    type!: ContentType;
-
-    @Column('varchar', { nullable: true })
-    title?: string;
-
-    @Column('varchar', { nullable: true })
-    navTitle?: string;
-
-    @Column('text', { nullable: true })
-    description?: string;
-
-    @Column('simple-json', { nullable: true })
-    flags?: Partial<Record<ContentFlag, boolean>>;
-
-    @Column('varchar', { nullable: true })
-    decoration?: string;
-
-    @Column('simple-json', { nullable: true })
-    seo?: Partial<ContentSeo>;
-
-    @Column('simple-json', { nullable: true })
-    ogImage?: ImageData;
-
-    @Column('simple-array', { nullable: true })
-    dependencies?: string[];
-
-    @Column('simple-json', { nullable: true })
-    references?: ContentReferences;
-}

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

@@ -1,10 +0,0 @@
-import { Entity, PrimaryColumn } from 'typeorm';
-
-@Entity('contribution')
-export class DbContribution {
-    @PrimaryColumn('varchar')
-    contentId!: string;
-
-    @PrimaryColumn('varchar')
-    contributorId!: string;
-}

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

@@ -1,25 +0,0 @@
-import { Column, Entity, PrimaryColumn } from 'typeorm';
-
-@Entity('contributor')
-export class DbContributor {
-    @PrimaryColumn('varchar')
-    contributorId!: string;
-
-    @Column('varchar', { nullable: true })
-    displayName?: string;
-
-    @Column('varchar', { nullable: true })
-    slogan?: string;
-
-    @Column('simple-json', { nullable: true })
-    links?: Record<string, string>;
-
-    @Column('text', { nullable: true })
-    description?: string;
-
-    @Column('varchar', { nullable: true })
-    avatar?: string;
-
-    @Column('boolean', { nullable: true })
-    isEditor?: boolean;
-}

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

@@ -1,10 +0,0 @@
-import { Column, Entity, PrimaryColumn } from 'typeorm';
-
-@Entity('file')
-export class DbFile {
-    @PrimaryColumn('varchar')
-    path!: string;
-
-    @Column('varchar', { unique: true })
-    fullPath!: string;
-}

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

@@ -1,11 +0,0 @@
-import { Column, Entity, PrimaryColumn } from 'typeorm';
-import type { GroupType } from '@erudit-js/cog/schema';
-
-@Entity('group')
-export class DbGroup {
-    @PrimaryColumn('varchar')
-    contentId!: string;
-
-    @Column('varchar')
-    type!: GroupType;
-}