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

package/server/tsconfig.json

@@ -1,9 +1,9 @@
-{
-    "extends": "../../../playground/.erudit/nuxt/.nuxt/tsconfig.server.json",
-    "compilerOptions": {
-        "verbatimModuleSyntax": true,
-        "experimentalDecorators": true,
-        "emitDecoratorMetadata": true
-    },
-    "exclude": ["../module/**/*", "../globalPath.ts"]
-}
+{
+    "extends": "../../../playground/.erudit/nuxt/.nuxt/tsconfig.server.json",
+    "compilerOptions": {
+        "verbatimModuleSyntax": true,
+        "experimentalDecorators": true,
+        "emitDecoratorMetadata": true
+    },
+    "exclude": ["../module/**/*", "../globalPath.ts"]
+}

package/shared/aside/minor.ts

@@ -1,50 +1,55 @@
-import type { BitranLocation } from '../bitran/location';
-import type { Toc } from '../bitran/toc';
-import type { PreviousNextItem } from '../content/previousNext';
-import type { ContentContributor } from '../contributor';
-
-interface AsideMinorBase {
-    type: AsideMinorType;
-}
-
-export type AsideMinorType =
-    | 'topic'
-    | 'group'
-    | 'book'
-    | 'contributor'
-    | 'news';
-
-export interface AsideMinorTopic extends AsideMinorBase {
-    type: 'topic';
-    fullContentId: string;
-    location: BitranLocation;
-    nav: Partial<{
-        previous: PreviousNextItem;
-        next: PreviousNextItem;
-        article: string;
-        summary: string;
-        practice: string;
-    }>;
-    toc: Toc;
-    contributors?: ContentContributor[];
-    // todos: TodoItem[];
-}
-
-export interface AsideMinorContent extends AsideMinorBase {
-    type: 'group' | 'book';
-    fullContentId: string;
-    nav: Partial<{
-        previous: PreviousNextItem;
-        next: PreviousNextItem;
-    }>;
-    contributors?: ContentContributor[];
-}
-
-export interface AsideMinorNews extends AsideMinorBase {
-    type: 'news';
-}
-
-export type AsideMinorData =
-    | AsideMinorTopic
-    | AsideMinorContent
-    | AsideMinorNews;
+import type { ContentType, TopicPart } from '@erudit-js/cog/schema';
+
+import type { Toc } from '@shared/bitran/toc';
+import type { PreviousNext } from '@shared/content/previousNext';
+import type { ContentContributor, Contribution } from '@shared/contributor';
+
+export type AsideMinorType = ContentType | 'contributor' | 'news';
+
+interface AsideMinorBase {
+    type: AsideMinorType;
+}
+
+export interface AsideMinorContentBase extends AsideMinorBase {
+    type: ContentType;
+    fullContentId: string;
+    shortContentId: string;
+    fsContentDirectory: string;
+    previousNext: PreviousNext;
+    contributors?: ContentContributor[];
+}
+
+export interface AsideMinorBook extends AsideMinorContentBase {
+    type: 'book';
+}
+
+export interface AsideMinorGroup extends AsideMinorContentBase {
+    type: 'group';
+}
+
+export interface AsideMinorTopic extends AsideMinorContentBase {
+    type: 'topic';
+    toc: Toc;
+    part: TopicPart;
+    partLinks: Partial<{
+        article: string;
+        summary: string;
+        practice: string;
+    }>;
+}
+
+export interface AsideMinorContributor extends AsideMinorBase {
+    type: 'contributor';
+    contributions: Contribution[];
+}
+
+export interface AsideMinorNews extends AsideMinorBase {
+    type: 'news';
+}
+
+export type AsideMinorData =
+    | AsideMinorBook
+    | AsideMinorGroup
+    | AsideMinorTopic
+    | AsideMinorContributor
+    | AsideMinorNews;

package/shared/asset.ts

@@ -1,15 +1,17 @@
-export function eruditAsset(path: string) {
-    return '/_erudit-asset/' + path;
-}
-
-export function contributorAsset(path: string) {
-    return '/_user-asset/contributor/' + path;
-}
-
-export function contentAsset(path: string) {
-    return '/_user-asset/content/' + path;
-}
-
-export function publicAsset(path: string) {
-    return '/_user-asset/public/' + path;
-}
+import {
+    PUBLIC_CONTENT_ASSET,
+    PUBLIC_ERUDIT_ASSET,
+    PUBLIC_USER_ASSET,
+} from '@erudit/const';
+
+export function eruditAsset(path: string) {
+    return PUBLIC_ERUDIT_ASSET + path;
+}
+
+export function contentAsset(path: string) {
+    return PUBLIC_CONTENT_ASSET + path;
+}
+
+export function publicAsset(path: string) {
+    return PUBLIC_USER_ASSET + path;
+}

package/shared/bitran/content.ts

@@ -0,0 +1,9 @@
+import type { RenderDataStorage } from '@bitran-js/core';
+import type { BitranContext } from '@erudit-js/cog/schema';
+
+export interface RawBitranContent {
+    biCode: string;
+    storage: RenderDataStorage;
+    routes: string[];
+    context: BitranContext;
+}

package/shared/bitran/contentId.ts

@@ -0,0 +1,56 @@
+import { detectContentBookId } from '../content/bookId';
+
+export function toAbsoluteContentPath(
+    contentPath: string,
+    contextPath: string,
+    bookIds?: string[],
+) {
+    const unresolvedPath = (() => {
+        if (contentPath.startsWith('/')) {
+            return contentPath;
+        }
+
+        if (contentPath.startsWith('~/')) {
+            const restPath = contentPath.substring(2);
+            const bookId = detectContentBookId(contextPath, bookIds ?? []);
+
+            if (bookId) {
+                return bookId + '/' + restPath;
+            }
+
+            // Not in any book, convert to absolute path
+            return '/' + restPath;
+        }
+
+        return contextPath + '/' + contentPath;
+    })();
+
+    return resolveContentPath(unresolvedPath);
+}
+
+export function resolveContentPath(toResolvePath: string) {
+    const reverseParts = toResolvePath.split('/').reverse();
+    const resolvedParts: string[] = [];
+
+    let skipCounter = 0;
+
+    for (let i = 0; i < reverseParts.length; i++) {
+        const part = reverseParts[i];
+
+        if (part === '..') {
+            skipCounter++;
+            continue;
+        }
+
+        if (skipCounter) {
+            skipCounter--;
+            continue;
+        }
+
+        if (part && part !== '.') {
+            resolvedParts.unshift(part);
+        }
+    }
+
+    return resolvedParts.join('/');
+}

package/shared/bitran/toc.ts

@@ -1,8 +1,8 @@
-export interface TocItem {
-    id: string;
-    level: number;
-    productName: string;
-    title?: string;
-}
-
-export type Toc = TocItem[];
+export interface TocItem {
+    id: string;
+    level: number;
+    productName: string;
+    title?: string;
+}
+
+export type Toc = TocItem[];

package/shared/breadcrumb.ts

@@ -0,0 +1,7 @@
+import type { MyIconName } from '#my-icons';
+
+export interface BreadcrumbItem {
+    title: string;
+    icon: MyIconName;
+    link: string;
+}

package/shared/content/bookId.ts

@@ -0,0 +1,12 @@
+export function detectContentBookId(contentId: string, bookIds: string[]) {
+    let bestMatch: string | undefined = undefined;
+    for (const bookId of bookIds) {
+        if (contentId.startsWith(bookId)) {
+            if (!bestMatch || bookId.length > bestMatch.length) {
+                bestMatch = bookId;
+            }
+        }
+    }
+
+    return bestMatch;
+}

package/shared/content/context.ts

@@ -1,9 +1,9 @@
-export interface ContextItem {
-    type: string;
-    icon: string;
-    title: string;
-    href: string;
-    hidden: boolean;
-}
-
-export type Context = ContextItem[];
+export interface ContextItem {
+    type: string;
+    icon: string;
+    title: string;
+    href: string;
+    hidden: boolean;
+}
+
+export type Context = ContextItem[];

package/shared/content/data/base.ts

@@ -1,32 +1,32 @@
-import type {
-    ContentFlag,
-    ContentReferences,
-    ContentSeo,
-    ContentType,
-    TopicPart,
-} from 'erudit-cog/schema';
-
-import type { Context } from '@shared/content/context';
-import type { PreviousNext } from '@shared/content/previousNext';
-import type { ImageData } from '@shared/image';
-
-export interface ContentGenericData {
-    contentId: string;
-    title?: string;
-    description?: string;
-    decoration?: string;
-    type: ContentType;
-    context: Context;
-    flags: Record<ContentFlag, boolean>;
-    topicPart?: TopicPart;
-    seo?: Partial<ContentSeo>;
-    ogImage?: ImageData;
-    previousNext: PreviousNext;
-    dependencies?: Record<string, string>;
-    references?: ContentReferences;
-}
-
-export interface ContentBaseData {
-    type: ContentType;
-    generic: ContentGenericData;
-}
+import type {
+    ContentFlag,
+    ContentReferences,
+    ContentSeo,
+    ContentType,
+    TopicPart,
+} from '@erudit-js/cog/schema';
+
+import type { Context } from '@shared/content/context';
+import type { PreviousNext } from '@shared/content/previousNext';
+import type { ImageData } from '@shared/image';
+
+export interface ContentGenericData {
+    contentId: string;
+    title?: string;
+    description?: string;
+    decoration?: string;
+    type: ContentType;
+    context: Context;
+    flags: Record<ContentFlag, boolean>;
+    topicPart?: TopicPart;
+    seo?: Partial<ContentSeo>;
+    ogImage?: ImageData;
+    previousNext: PreviousNext;
+    dependencies?: Record<string, string>;
+    references?: ContentReferences;
+}
+
+export interface ContentBaseData {
+    type: ContentType;
+    generic: ContentGenericData;
+}

package/shared/content/data/index.ts

@@ -1,5 +1,5 @@
-import type { ContentTopicData } from './type/topic';
-import type { ContentGroupData } from './type/group';
-import type { ContentBookData } from './type/book';
-
-export type ContentData = ContentTopicData | ContentGroupData | ContentBookData;
+import type { ContentTopicData } from './type/topic';
+import type { ContentGroupData } from './type/group';
+import type { ContentBookData } from './type/book';
+
+export type ContentData = ContentTopicData | ContentGroupData | ContentBookData;

package/shared/content/data/type/book.ts

@@ -1,5 +1,5 @@
-import type { ContentBaseData } from '../base';
-
-export interface ContentBookData extends ContentBaseData {
-    type: 'book';
-}
+import type { ContentBaseData } from '../base';
+
+export interface ContentBookData extends ContentBaseData {
+    type: 'book';
+}

package/shared/content/data/type/group.ts

@@ -1,6 +1,6 @@
-import type { ContentBaseData } from '../base';
-
-export interface ContentGroupData extends ContentBaseData {
-    type: 'group';
-    bookTitle?: string;
-}
+import type { ContentBaseData } from '../base';
+
+export interface ContentGroupData extends ContentBaseData {
+    type: 'group';
+    bookTitle?: string;
+}

package/shared/content/data/type/topic.ts

@@ -1,11 +1,11 @@
-import type { TopicPart } from 'erudit-cog/schema';
-
-import type { ContentBaseData } from '../base';
-
-export type TopicPartLinks = Partial<Record<TopicPart, string>>;
-
-export interface ContentTopicData extends ContentBaseData {
-    type: 'topic';
-    topicPartLinks: TopicPartLinks;
-    bookTitle?: string;
-}
+import type { TopicPart } from '@erudit-js/cog/schema';
+
+import type { ContentBaseData } from '../base';
+
+export type TopicPartLinks = Partial<Record<TopicPart, string>>;
+
+export interface ContentTopicData extends ContentBaseData {
+    type: 'topic';
+    topicPartLinks: TopicPartLinks;
+    bookTitle?: string;
+}

package/shared/content/previousNext.ts

@@ -1,9 +1,9 @@
-export interface PreviousNext {
-    next?: PreviousNextItem;
-    previous?: PreviousNextItem;
-}
-
-export interface PreviousNextItem {
-    title: string;
-    link: string;
-}
+export interface PreviousNext {
+    next?: PreviousNextItem;
+    previous?: PreviousNextItem;
+}
+
+export interface PreviousNextItem {
+    title: string;
+    link: string;
+}

package/shared/contributor.ts

@@ -1,5 +1,34 @@
-export interface ContentContributor {
-    contributorId: string;
-    displayName?: string;
-    avatar?: string;
-}
+import type { ContentType } from '@erudit-js/cog/schema';
+
+export interface ContentContributor {
+    contributorId: string;
+    displayName?: string;
+    avatar?: string;
+}
+
+export interface Contribution {
+    bookId?: string;
+    bookTitle?: string;
+    contentType: ContentType;
+    contentTitle: string;
+    contentLink: string;
+}
+
+export interface PageContributor {
+    contributorId: string;
+    displayName?: string;
+    slogan?: string;
+    links?: Record<string, string>;
+    avatar?: string;
+    isEditor?: boolean;
+    hasDescription?: boolean;
+    contributions?: Contribution[];
+}
+
+export interface ContributorListItem {
+    contributorId: string;
+    displayName?: string;
+    isEditor?: boolean;
+    avatar?: string;
+    contributions: number;
+}

package/shared/frontNav.ts

@@ -1,41 +1,41 @@
-import type { ContentFlag, TopicPart } from 'erudit-cog/schema';
-
-export type FrontNavType = 'book' | 'topic' | 'separator' | 'folder';
-
-export interface FrontNavBase {
-    type: FrontNavType;
-    id: string;
-    fullId: string;
-    label: string;
-    level: number;
-    flags?: Record<ContentFlag, boolean>;
-}
-
-export interface FrontNavTopic extends FrontNavBase {
-    type: 'topic';
-    part: TopicPart;
-}
-
-export interface FrontNavContainer extends FrontNavBase {
-    children?: FrontNavItem[];
-}
-
-export interface FrontNavBook extends FrontNavContainer {
-    type: 'book';
-}
-
-export interface FrontNavSeparator extends FrontNavContainer {
-    type: 'separator';
-}
-
-export interface FrontNavFolder extends FrontNavContainer {
-    type: 'folder';
-}
-
-export type FrontNavItem =
-    | FrontNavTopic
-    | FrontNavBook
-    | FrontNavSeparator
-    | FrontNavFolder;
-
-export type FrontNav = FrontNavItem[];
+import type { ContentFlag, TopicPart } from '@erudit-js/cog/schema';
+
+export type FrontNavType = 'book' | 'topic' | 'separator' | 'folder';
+
+export interface FrontNavBase {
+    type: FrontNavType;
+    id: string;
+    fullId: string;
+    label: string;
+    level: number;
+    flags?: Partial<Record<ContentFlag, boolean>>;
+}
+
+export interface FrontNavTopic extends FrontNavBase {
+    type: 'topic';
+    part: TopicPart;
+}
+
+export interface FrontNavContainer extends FrontNavBase {
+    children?: FrontNavItem[];
+}
+
+export interface FrontNavBook extends FrontNavContainer {
+    type: 'book';
+}
+
+export interface FrontNavSeparator extends FrontNavContainer {
+    type: 'separator';
+}
+
+export interface FrontNavFolder extends FrontNavContainer {
+    type: 'folder';
+}
+
+export type FrontNavItem =
+    | FrontNavTopic
+    | FrontNavBook
+    | FrontNavSeparator
+    | FrontNavFolder;
+
+export type FrontNav = FrontNavItem[];

package/shared/icons.ts

@@ -1,38 +1,38 @@
-import {
-    isContentType,
-    isTopicPart,
-    type ContentType,
-    type TopicPart,
-} from 'erudit-cog/schema';
-
-import type { MyIconName } from '#my-icons';
-import type { BitranLocation } from './bitran/location';
-
-export const TOPIC_PART_ICON = {
-    article: 'outline/file-lines',
-    summary: 'file-star',
-    practice: 'file-check',
-} satisfies Record<TopicPart, MyIconName>;
-
-export const CONTENT_TYPE_ICON = {
-    book: 'outline/book',
-    group: 'folder',
-    topic: 'outline/file-lines',
-} satisfies Record<ContentType, MyIconName>;
-
-export const ICON = {
-    contributor: 'user',
-} satisfies Record<string, MyIconName>;
-
-export function locationIcon(location: BitranLocation): MyIconName {
-    if (isTopicPart(location.type)) return TOPIC_PART_ICON[location.type];
-
-    if (isContentType(location.type)) return CONTENT_TYPE_ICON[location.type];
-
-    switch (location.type) {
-        case 'contributor':
-            return ICON['contributor'];
-    }
-
-    return '__missing';
-}
+import {
+    isContentType,
+    isTopicPart,
+    type BitranLocation,
+    type ContentType,
+    type TopicPart,
+} from '@erudit-js/cog/schema';
+
+import type { MyIconName } from '#my-icons';
+
+export const TOPIC_PART_ICON = {
+    article: 'outline/file-lines',
+    summary: 'file-star',
+    practice: 'file-check',
+} satisfies Record<TopicPart, MyIconName>;
+
+export const CONTENT_TYPE_ICON = {
+    book: 'outline/book',
+    group: 'folder',
+    topic: 'outline/file-lines',
+} satisfies Record<ContentType, MyIconName>;
+
+export const ICON = {
+    contributor: 'user',
+} satisfies Record<string, MyIconName>;
+
+export function locationIcon(location: BitranLocation): MyIconName {
+    if (isTopicPart(location.type)) return TOPIC_PART_ICON[location.type];
+
+    if (isContentType(location.type)) return CONTENT_TYPE_ICON[location.type];
+
+    switch (location.type) {
+        case 'contributor':
+            return ICON['contributor'];
+    }
+
+    return '__missing';
+}

package/shared/image.ts

@@ -1,5 +1,5 @@
-export interface ImageData {
-    src: string;
-    width: number;
-    height: number;
-}
+export interface ImageData {
+    src: string;
+    width: number;
+    height: number;
+}