erudit 3.0.0-dev.8 → 4.0.0-dev.1

package/server/plugin/content/absoluteId.ts

@@ -1,94 +0,0 @@
-import { isTopicPart } from '@erudit-js/cog/schema';
-
-import {
-    parseBitranLocation,
-    stringifyBitranLocation,
-    type BitranLocation,
-} from '@erudit-js/cog/schema';
-import { getNavBookOf } from '../nav/utils';
-
-export function toAbsoluteContentLocation<T extends string | BitranLocation>(
-    location: T,
-    contextContentId: string,
-): T {
-    const isLocationStr = typeof location === 'string';
-    const parsedLocation = isLocationStr
-        ? parseBitranLocation(location)
-        : (location as BitranLocation);
-
-    if (
-        isTopicPart(parsedLocation.type) ||
-        ['book', 'group', 'topic'].includes(parsedLocation.type)
-    ) {
-        parsedLocation.path = toAbsoluteContentId(
-            parsedLocation.path!,
-            contextContentId,
-        );
-        return (
-            isLocationStr
-                ? stringifyBitranLocation(parsedLocation)
-                : parsedLocation
-        ) as T;
-    }
-
-    return location;
-}
-
-export function toAbsoluteContentId(
-    path: string,
-    contextContentId: string = '',
-) {
-    const fullPath = (() => {
-        if (path.startsWith('..'))
-            return (contextContentId ? contextContentId + '/' : '') + path;
-
-        if (path.startsWith('.'))
-            return trimEdgeSlashes(contextContentId + path.substring(1));
-
-        if (path.startsWith('~'))
-            return trimEdgeSlashes(
-                tryGetParentBook(contextContentId) + path.substring(1),
-            );
-
-        return path;
-    })();
-
-    const reversePathParts = fullPath.split('/').reverse();
-    const finalParts: string[] = [];
-
-    let skipCounter = 0;
-
-    for (let i = 0; i < reversePathParts.length; i++) {
-        const part = reversePathParts[i];
-
-        if (part === '..') {
-            skipCounter++;
-            continue;
-        }
-
-        if (skipCounter) {
-            skipCounter--;
-            continue;
-        }
-
-        finalParts.unshift(part!);
-    }
-
-    return finalParts.join('/');
-}
-
-function trimEdgeSlashes(path: string) {
-    if (path.startsWith('/')) path = path.substring(1);
-
-    if (path.endsWith('/')) path = path.substring(0, path.length - 1);
-
-    return path;
-}
-
-function tryGetParentBook(contentId: string): string {
-    const navBook = getNavBookOf(contentId);
-
-    if (!navBook) return '';
-
-    return navBook.id;
-}

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 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> {
-    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;
-}

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,49 +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')
-    @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?: 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,16 +0,0 @@
-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;
-}

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

@@ -1,14 +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;
-
-    @Column('text', { nullable: true })
-    content?: string;
-}

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

@@ -1,15 +0,0 @@
-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;
-}

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

@@ -1,20 +0,0 @@
-import { Column, Entity, PrimaryColumn } from 'typeorm';
-import type { TopicPart } from '@erudit-js/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 +0,0 @@
-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 +0,0 @@
-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,17 +0,0 @@
-import type { DataSource } from 'typeorm';
-import type { EruditBitranConfig, EruditConfig } from '@erudit-js/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 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-import chalk from 'chalk';
-import { createConsola } from 'consola';
-import { brandColorTitle } from '@erudit-js/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 +0,0 @@
-import type { ContentType } from '@erudit-js/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 +0,0 @@
-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 +0,0 @@
-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,
-    };
-}