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

package/server/plugin/build/rebuild.ts

@@ -1,55 +1,68 @@
-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',
-];
-
-const ignoreTargets: string[] = [];
-
-const rebuildDelay = 300;
-
-//
-//
-//
-
-let watcher: FSWatcher;
-let rebuildTimeout: any;
-let rebuildRequested = 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 (rebuildRequested) 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;
-    }, rebuildDelay);
-}
+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,21 +1,19 @@
-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';
-import { setupBitranConfig } from '../bitran/setup';
-
-export async function setup() {
-    debug.start('Running initial setup procedures...');
-
-    if (import.meta.dev) await setupRebuildWatcher();
-
-    registerGlobals();
-    ERUDIT_SERVER.CONFIG = eruditConfig;
-
-    await setupBitranConfig();
-    await setupDatabase();
-}
+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,112 +1,119 @@
-import { isContentType, isTopicPart, type TopicPart } from 'erudit-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 type { Context } from '@shared/content/context';
-import {
-    createContentLink,
-    createContributorLink,
-    createTopicPartLink,
-} from '@shared/link';
-import { CONTENT_TYPE_ICON, ICON, TOPIC_PART_ICON } from '@erudit/shared/icons';
-import type { BitranLocation } from '@erudit/shared/bitran/location';
-
-export async function getContentContext(contentId: string): Promise<Context> {
-    const context: Context = [];
-
-    for (const _contentId of (await 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: createContentLink(dbContent.type, 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', 'fullId', 'contentId'],
-        where: { contentId },
-    });
-
-    if (!dbContent) throw new Error(`Content "${contentId}" not found!`);
-
-    return dbContent;
-}
+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 {
+    createContentLink,
+    createContributorLink,
+    createTopicPartLink,
+} from '@shared/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: createContentLink(dbContent.type, 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 +1,7 @@
-import { Entity, PrimaryColumn } from 'typeorm';
-
-@Entity('book')
-export class DbBook {
-    @PrimaryColumn('varchar')
-    contentId!: string;
-}
+import { Entity, PrimaryColumn } from 'typeorm';
+
+@Entity('book')
+export class DbBook {
+    @PrimaryColumn('varchar')
+    contentId!: string;
+}

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

@@ -1,49 +1,45 @@
-import { Column, Entity, Index, PrimaryColumn } from 'typeorm';
-import type {
-    ContentFlag,
-    ContentReferences,
-    ContentSeo,
-    ContentType,
-} from 'erudit-cog/schema';
-
-import type { ImageData } from '@erudit/shared/image';
-
-@Entity('content')
-export class DbContent {
-    @PrimaryColumn('varchar')
-    contentId!: string;
-
-    @Column('varchar')
-    @Index({ unique: true })
-    fullId!: 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?: 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;
-}
+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 +1,10 @@
-import { Entity, PrimaryColumn } from 'typeorm';
-
-@Entity('contribution')
-export class DbContribution {
-    @PrimaryColumn('varchar')
-    contentId!: string;
-
-    @PrimaryColumn('varchar')
-    contributorId!: string;
-}
+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,16 +1,25 @@
-import { Column, Entity, PrimaryColumn } from 'typeorm';
-
-@Entity('contributor')
-export class DbContributor {
-    @PrimaryColumn('varchar')
-    contributorId!: string;
-
-    @Column('varchar', { nullable: true })
-    displayName?: string;
-
-    @Column('text', { nullable: true })
-    description?: string;
-
-    @Column('varchar', { nullable: true })
-    avatar?: string;
-}
+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

@@ -0,0 +1,10 @@
+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,14 +1,14 @@
-import { Column, Entity, PrimaryColumn } from 'typeorm';
-import type { GroupType } from 'erudit-cog/schema';
-
-@Entity('group')
-export class DbGroup {
-    @PrimaryColumn('varchar')
-    contentId!: string;
-
-    @Column('varchar')
-    type!: GroupType;
-
-    @Column('text', { nullable: true })
-    content?: string;
-}
+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;
+
+    @Column('text', { nullable: true })
+    content?: string;
+}

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

@@ -1,15 +1,15 @@
-import { Column, Entity, PrimaryColumn } from 'typeorm';
-
-/**
- * TODO:
- * Create hash of Bitran content of content items and use it to distinguish between content item version.
- */
-
-@Entity('hash')
-export class DbHash {
-    @PrimaryColumn('varchar')
-    id!: string;
-
-    @Column('varchar')
-    hash!: string;
-}
+import { Column, Entity, PrimaryColumn } from 'typeorm';
+
+/**
+ * TODO:
+ * Create hash of Bitran content of content items and use it to distinguish between content item version.
+ */
+
+@Entity('hash')
+export class DbHash {
+    @PrimaryColumn('varchar')
+    id!: string;
+
+    @Column('varchar')
+    hash!: string;
+}