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

package/server/plugin/content/absoluteId.ts

@@ -1,94 +1,94 @@
-import { isTopicPart } from 'erudit-cog/schema';
-
-import {
-    parseBitranLocation,
-    stringifyBitranLocation,
-    type BitranLocation,
-} from '@shared/bitran/location';
-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;
-}
+import { isTopicPart } from 'erudit-cog/schema';
+
+import {
+    parseBitranLocation,
+    stringifyBitranLocation,
+    type BitranLocation,
+} from '@shared/bitran/location';
+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,112 +1,112 @@
-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 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;
+}

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,49 @@
-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-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;
+}

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,16 @@
-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('text', { nullable: true })
+    description?: string;
+
+    @Column('varchar', { nullable: true })
+    avatar?: 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-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;
+}