erudit 3.0.0-dev.3 → 3.0.0-dev.5

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

@@ -1,20 +1,20 @@
-import { Column, Entity, PrimaryColumn } from 'typeorm';
-import type { TopicPart } from 'erudit-cog/schema';
-
-@Entity('topic')
-export class DbTopic {
-    @PrimaryColumn('varchar')
-    contentId!: string;
-
-    @Column('simple-array')
-    parts!: TopicPart[];
-
-    @Column('text', { nullable: true })
-    article?: string;
-
-    @Column('text', { nullable: true })
-    summary?: string;
-
-    @Column('text', { nullable: true })
-    practice?: string;
-}
+import { Column, Entity, PrimaryColumn } from 'typeorm';
+import type { TopicPart } from 'erudit-cog/schema';
+
+@Entity('topic')
+export class DbTopic {
+    @PrimaryColumn('varchar')
+    contentId!: string;
+
+    @Column('simple-array')
+    parts!: TopicPart[];
+
+    @Column('text', { nullable: true })
+    article?: string;
+
+    @Column('text', { nullable: true })
+    summary?: string;
+
+    @Column('text', { nullable: true })
+    practice?: string;
+}

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

@@ -1,21 +1,21 @@
-import { Column, Entity, PrimaryColumn } from 'typeorm';
-
-import type { BitranContext } from '@erudit/shared/bitran/context';
-
-@Entity('unique')
-export class DbUnique {
-    @PrimaryColumn('varchar')
-    location!: string;
-
-    @Column('varchar')
-    productName!: string;
-
-    @Column('text')
-    content!: string;
-
-    @Column('simple-json')
-    context!: BitranContext;
-
-    @Column('varchar', { nullable: true })
-    title?: string;
-}
+import { Column, Entity, PrimaryColumn } from 'typeorm';
+
+import type { BitranContext } from '@erudit/shared/bitran/context';
+
+@Entity('unique')
+export class DbUnique {
+    @PrimaryColumn('varchar')
+    location!: string;
+
+    @Column('varchar')
+    productName!: string;
+
+    @Column('text')
+    content!: string;
+
+    @Column('simple-json')
+    context!: BitranContext;
+
+    @Column('varchar', { nullable: true })
+    title?: string;
+}

package/server/plugin/db/setup.ts

@@ -1,34 +1,34 @@
-import { DataSource } from 'typeorm';
-
-import { PROJECT_DIR } from '#erudit/globalPaths';
-import { ERUDIT_SERVER } from '@server/global';
-
-// Database Entities
-import { DbContributor } from './entities/Contributor';
-import { DbBook } from './entities/Book';
-import { DbContent } from './entities/Content';
-import { DbContribution } from './entities/Contribution';
-import { DbGroup } from './entities/Group';
-import { DbHash } from './entities/Hash';
-import { DbTopic } from './entities/Topic';
-import { DbUnique } from './entities/Unique';
-
-export async function setupDatabase() {
-    ERUDIT_SERVER.DB = new DataSource({
-        type: 'sqlite',
-        database: PROJECT_DIR + '/.erudit/data.sqlite',
-        synchronize: true,
-        entities: [
-            DbBook,
-            DbContent,
-            DbContribution,
-            DbContributor,
-            DbGroup,
-            DbHash,
-            DbTopic,
-            DbUnique,
-        ],
-    });
-
-    await ERUDIT_SERVER.DB.initialize();
-}
+import { DataSource } from 'typeorm';
+
+import { PROJECT_DIR } from '#erudit/globalPaths';
+import { ERUDIT_SERVER } from '@server/global';
+
+// Database Entities
+import { DbContributor } from './entities/Contributor';
+import { DbBook } from './entities/Book';
+import { DbContent } from './entities/Content';
+import { DbContribution } from './entities/Contribution';
+import { DbGroup } from './entities/Group';
+import { DbHash } from './entities/Hash';
+import { DbTopic } from './entities/Topic';
+import { DbUnique } from './entities/Unique';
+
+export async function setupDatabase() {
+    ERUDIT_SERVER.DB = new DataSource({
+        type: 'sqlite',
+        database: PROJECT_DIR + '/.erudit/data.sqlite',
+        synchronize: true,
+        entities: [
+            DbBook,
+            DbContent,
+            DbContribution,
+            DbContributor,
+            DbGroup,
+            DbHash,
+            DbTopic,
+            DbUnique,
+        ],
+    });
+
+    await ERUDIT_SERVER.DB.initialize();
+}

package/server/plugin/global.ts

@@ -1,18 +1,17 @@
-import type { DataSource } from 'typeorm';
-import type { EruditConfig } from 'erudit-cog/schema';
-
-import type { EruditPhrases } from '@shared/types/language';
-import type { NavNode, RootNavNode } from '@server/nav/node';
-import type { EruditBitranConfig } from '@erudit/globals/bitran';
-
-interface EruditServer {
-    BUILD_PROMISE: Promise<void>;
-    CONFIG: Partial<EruditConfig>;
-    LANGUAGE: { phrases: EruditPhrases; functions: Record<string, Function> };
-    DB: DataSource;
-    NAV?: RootNavNode;
-    NAV_BOOKS?: Record<string, NavNode>;
-    BITRAN_CONFIG?: Partial<EruditBitranConfig>;
-}
-
-export const ERUDIT_SERVER: EruditServer = {} as any;
+import type { DataSource } from 'typeorm';
+import type { EruditBitranConfig, EruditConfig } from 'erudit-cog/schema';
+
+import type { EruditPhrases } from '@shared/types/language';
+import type { NavNode, RootNavNode } from '@server/nav/node';
+
+interface EruditServer {
+    BUILD_PROMISE: Promise<void>;
+    CONFIG: Partial<EruditConfig>;
+    LANGUAGE: { phrases: EruditPhrases; functions: Record<string, Function> };
+    DB: DataSource;
+    NAV?: RootNavNode;
+    NAV_BOOKS?: Record<string, NavNode>;
+    BITRAN_CONFIG?: Partial<EruditBitranConfig>;
+}
+
+export const ERUDIT_SERVER: EruditServer = {} as any;

package/server/plugin/importer.ts

@@ -1,12 +1,12 @@
-import { createJiti } from 'jiti';
-import { ERUDIT_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,
-});
-
-export async function IMPORT(...args: Parameters<typeof jiti.import>) {
-    return jiti.import(...args) as Promise<any>;
-}
+import { createJiti } from 'jiti';
+import { ERUDIT_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,
+});
+
+export async function IMPORT(...args: Parameters<typeof jiti.import>) {
+    return jiti.import(...args) as Promise<any>;
+}

package/server/plugin/index.ts

@@ -1,9 +1,9 @@
-import { ERUDIT_SERVER } from './global';
-import { build } from './build/process';
-import { close } from './build/close';
-
-export default defineNitroPlugin((_nitro) => {
-    ERUDIT_SERVER.BUILD_PROMISE = build();
-    _nitro.hooks.hook('request', async () => await ERUDIT_SERVER.BUILD_PROMISE);
-    _nitro.hooks.hook('close', close);
-});
+import { ERUDIT_SERVER } from './global';
+import { build } from './build/process';
+import { close } from './build/close';
+
+export default defineNitroPlugin((_nitro) => {
+    ERUDIT_SERVER.BUILD_PROMISE = build();
+    _nitro.hooks.hook('request', async () => await ERUDIT_SERVER.BUILD_PROMISE);
+    _nitro.hooks.hook('close', close);
+});

package/server/plugin/logger.ts

@@ -1,23 +1,23 @@
-import chalk from 'chalk';
-import { createConsola } from 'consola';
-import { brandColorTitle } from 'erudit-cog/utils/brand';
-
-import eruditConfig from '#erudit/config';
-
-// TODO: Consola has buggy behaviour when called inside Nitro
-// @see https://github.com/nitrojs/nitro/issues/3079
-
-export const logger = createConsola({
-    defaults: {
-        //tag: brandColorTitle + ' Server',
-        message: chalk.gray(`[${brandColorTitle} Server]`),
-    },
-});
-
-export const debug = createConsola({
-    defaults: {
-        //tag: brandColorTitle + ' Server Debug',
-        message: chalk.gray(`[${brandColorTitle} Server Debug]`),
-        level: eruditConfig?.debug?.log ? 3 : -999,
-    },
-});
+import chalk from 'chalk';
+import { createConsola } from 'consola';
+import { brandColorTitle } from 'erudit-cog/utils/brandNode';
+
+import eruditConfig from '#erudit/config';
+
+// TODO: Consola has buggy behaviour when called inside Nitro
+// @see https://github.com/nitrojs/nitro/issues/3079
+
+export const logger = createConsola({
+    defaults: {
+        //tag: brandColorTitle + ' Server',
+        message: chalk.gray(`[${brandColorTitle} Server]`),
+    },
+});
+
+export const debug = createConsola({
+    defaults: {
+        //tag: brandColorTitle + ' Server Debug',
+        message: chalk.gray(`[${brandColorTitle} Server Debug]`),
+        level: eruditConfig?.debug?.log ? 3 : -999,
+    },
+});

package/server/plugin/nav/node.ts

@@ -1,26 +1,26 @@
-import type { ContentType } from 'erudit-cog/schema';
-
-export interface NavNode {
-    type: ContentType;
-    path: string;
-    id: string;
-    fullId: string;
-    skip: boolean;
-    children?: NavNode[];
-    parent?: NavNode | RootNavNode;
-}
-
-export interface RootNavNode {
-    type: '#root';
-    children?: NavNode[];
-}
-
-export function isRootNode(node: NavNode | RootNavNode) {
-    return node?.type === '#root';
-}
-
-export function createRootNode(): RootNavNode {
-    return {
-        type: '#root',
-    };
-}
+import type { ContentType } from 'erudit-cog/schema';
+
+export interface NavNode {
+    type: ContentType;
+    path: string;
+    id: string;
+    fullId: string;
+    skip: boolean;
+    children?: NavNode[];
+    parent?: NavNode | RootNavNode;
+}
+
+export interface RootNavNode {
+    type: '#root';
+    children?: NavNode[];
+}
+
+export function isRootNode(node: NavNode | RootNavNode) {
+    return node?.type === '#root';
+}
+
+export function createRootNode(): RootNavNode {
+    return {
+        type: '#root',
+    };
+}

package/server/plugin/nav/utils.ts

@@ -1,129 +1,129 @@
-import { ERUDIT_SERVER } from '@server/global';
-import { isRootNode, type NavNode } from '@server/nav/node';
-
-export async function walkNav(
-    step: (node: NavNode) => Promise<void | false>,
-    from: NavNode | typeof ERUDIT_SERVER.NAV = ERUDIT_SERVER.NAV,
-) {
-    if (!from) return;
-
-    const stepResult = isRootNode(from) ? true : await step(from);
-
-    if (stepResult !== false)
-        if (from.children)
-            for (const child of from.children) await walkNav(step, child);
-}
-
-//
-//
-//
-
-export function getNavBookOf(target: string | NavNode): NavNode | undefined {
-    const id = typeof target === 'string' ? target : target.id;
-
-    if (!id || !ERUDIT_SERVER.NAV_BOOKS) return undefined;
-
-    const idParts = id.split('/');
-
-    while (idParts.length > 0) {
-        const book = ERUDIT_SERVER.NAV_BOOKS[idParts.join('/')];
-
-        if (book) return book;
-
-        idParts.pop();
-    }
-
-    return undefined;
-}
-
-export async function getPreviousNextNav(contentId: string) {
-    let previousNav: NavNode | undefined, nextNav: NavNode | undefined;
-    let book: NavNode | undefined;
-    let finish = false;
-
-    await walkNav(async (navNode) => {
-        if (navNode.id === contentId) {
-            book = getNavBookOf(navNode);
-            finish = true;
-            return;
-        }
-
-        if (finish && !nextNav) {
-            nextNav = navNode;
-            return false;
-        }
-
-        if (!finish) previousNav = navNode;
-    });
-
-    if (book) {
-        //
-        // Can't lead out of current book (if givent content item is inside the book)
-        //
-
-        if (previousNav)
-            if (getNavBookOf(previousNav)?.fullId !== book.fullId)
-                previousNav = undefined;
-
-        if (nextNav)
-            if (getNavBookOf(nextNav)?.fullId !== book.fullId)
-                nextNav = undefined;
-    } else {
-        //
-        // If not inside the book and tries to lead inside a book, then force lead to book's about page
-        //
-
-        if (previousNav) previousNav = getNavBookOf(previousNav) || previousNav;
-
-        if (nextNav) nextNav = getNavBookOf(nextNav) || nextNav;
-    }
-
-    return {
-        previousNav,
-        nextNav,
-    };
-}
-
-export async function getNavNode(
-    contentId: string,
-): Promise<NavNode | undefined> {
-    let navNode: NavNode | undefined;
-
-    await walkNav(async (_navNode) => {
-        if (_navNode.id === contentId) {
-            navNode = _navNode;
-            return false;
-        }
-    });
-
-    return navNode;
-}
-
-export async function getIdsUp(contentId: string): Promise<string[]> {
-    const startNavNode = await getNavNode(contentId);
-
-    if (!startNavNode) return [];
-
-    const ids: string[] = [];
-
-    let currentNavNode: any = startNavNode;
-    while (currentNavNode?.id) {
-        ids.push(currentNavNode.id);
-        currentNavNode = currentNavNode.parent;
-    }
-
-    return ids;
-}
-
-export async function isSkipId(contentId: string) {
-    let hidden = false;
-
-    await walkNav(async (navNode) => {
-        if (navNode.id === contentId) {
-            hidden = navNode.skip;
-            return false;
-        }
-    });
-
-    return hidden;
-}
+import { ERUDIT_SERVER } from '@server/global';
+import { isRootNode, type NavNode } from '@server/nav/node';
+
+export async function walkNav(
+    step: (node: NavNode) => Promise<void | false>,
+    from: NavNode | typeof ERUDIT_SERVER.NAV = ERUDIT_SERVER.NAV,
+) {
+    if (!from) return;
+
+    const stepResult = isRootNode(from) ? true : await step(from);
+
+    if (stepResult !== false)
+        if (from.children)
+            for (const child of from.children) await walkNav(step, child);
+}
+
+//
+//
+//
+
+export function getNavBookOf(target: string | NavNode): NavNode | undefined {
+    const id = typeof target === 'string' ? target : target.id;
+
+    if (!id || !ERUDIT_SERVER.NAV_BOOKS) return undefined;
+
+    const idParts = id.split('/');
+
+    while (idParts.length > 0) {
+        const book = ERUDIT_SERVER.NAV_BOOKS[idParts.join('/')];
+
+        if (book) return book;
+
+        idParts.pop();
+    }
+
+    return undefined;
+}
+
+export async function getPreviousNextNav(contentId: string) {
+    let previousNav: NavNode | undefined, nextNav: NavNode | undefined;
+    let book: NavNode | undefined;
+    let finish = false;
+
+    await walkNav(async (navNode) => {
+        if (navNode.id === contentId) {
+            book = getNavBookOf(navNode);
+            finish = true;
+            return;
+        }
+
+        if (finish && !nextNav) {
+            nextNav = navNode;
+            return false;
+        }
+
+        if (!finish) previousNav = navNode;
+    });
+
+    if (book) {
+        //
+        // Can't lead out of current book (if givent content item is inside the book)
+        //
+
+        if (previousNav)
+            if (getNavBookOf(previousNav)?.fullId !== book.fullId)
+                previousNav = undefined;
+
+        if (nextNav)
+            if (getNavBookOf(nextNav)?.fullId !== book.fullId)
+                nextNav = undefined;
+    } else {
+        //
+        // If not inside the book and tries to lead inside a book, then force lead to book's about page
+        //
+
+        if (previousNav) previousNav = getNavBookOf(previousNav) || previousNav;
+
+        if (nextNav) nextNav = getNavBookOf(nextNav) || nextNav;
+    }
+
+    return {
+        previousNav,
+        nextNav,
+    };
+}
+
+export async function getNavNode(
+    contentId: string,
+): Promise<NavNode | undefined> {
+    let navNode: NavNode | undefined;
+
+    await walkNav(async (_navNode) => {
+        if (_navNode.id === contentId) {
+            navNode = _navNode;
+            return false;
+        }
+    });
+
+    return navNode;
+}
+
+export async function getIdsUp(contentId: string): Promise<string[]> {
+    const startNavNode = await getNavNode(contentId);
+
+    if (!startNavNode) return [];
+
+    const ids: string[] = [];
+
+    let currentNavNode: any = startNavNode;
+    while (currentNavNode?.id) {
+        ids.push(currentNavNode.id);
+        currentNavNode = currentNavNode.parent;
+    }
+
+    return ids;
+}
+
+export async function isSkipId(contentId: string) {
+    let hidden = false;
+
+    await walkNav(async (navNode) => {
+        if (navNode.id === contentId) {
+            hidden = navNode.skip;
+            return false;
+        }
+    });
+
+    return hidden;
+}

package/server/plugin/repository/book.ts

@@ -1,21 +1,21 @@
-import { ERUDIT_SERVER } from '@server/global';
-import { getNavBookOf } from '@server/nav/utils';
-import { DbContent } from '@server/db/entities/Content';
-
-export async function getContentBookFor(contentId: string) {
-    const navBook = getNavBookOf(contentId);
-
-    if (!navBook) return undefined;
-
-    const bookId = navBook.id;
-
-    const dbContent = await ERUDIT_SERVER.DB.manager.findOne(DbContent, {
-        select: ['title'],
-        where: { contentId: bookId },
-    });
-
-    return {
-        contentId: bookId,
-        title: dbContent?.title || bookId,
-    };
-}
+import { ERUDIT_SERVER } from '@server/global';
+import { getNavBookOf } from '@server/nav/utils';
+import { DbContent } from '@server/db/entities/Content';
+
+export async function getContentBookFor(contentId: string) {
+    const navBook = getNavBookOf(contentId);
+
+    if (!navBook) return undefined;
+
+    const bookId = navBook.id;
+
+    const dbContent = await ERUDIT_SERVER.DB.manager.findOne(DbContent, {
+        select: ['title'],
+        where: { contentId: bookId },
+    });
+
+    return {
+        contentId: bookId,
+        title: dbContent?.title || bookId,
+    };
+}