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

package/app/scripts/preview/build.ts

@@ -1,73 +1,76 @@
-import { PreviewDataType, type PreviewData } from './data';
-import { PreviewRequestType, type PreviewRequest } from './request';
-
-import { buildGenericLink } from './data/genericLink';
-import { buildPageLink } from './data/pageLink';
-import { buildUnique } from './data/unique';
-import { createPreviewError } from './data/alert';
-import { PreviewThemeName } from './state';
-
-const builders = [buildGenericLink, buildPageLink, buildUnique];
-
-export async function buildPreviewData(
-    request: PreviewRequest,
-): Promise<PreviewData> {
-    if (request.type === PreviewRequestType.Data) return request.data;
-
-    if (request.type === PreviewRequestType.MissingElement) {
-        if (request.hashMismatch) {
-            const phrase = await usePhrases(
-                'preview_missing_title',
-                'preview_missing_explain_mismatch',
-                'element_id',
-                'current_page_hash',
-                'expected_page_hash',
-            );
-
-            return createPreviewError({
-                title: phrase.preview_missing_title,
-                message: phrase.preview_missing_explain_mismatch,
-                pre: `${phrase.element_id}: ${request.elementId}\n${phrase.current_page_hash}: ${request.hashMismatch.current}\n${phrase.expected_page_hash}: ${request.hashMismatch.expected}`,
-            });
-        } else {
-            const phrase = await usePhrases(
-                'preview_missing_title',
-                'preview_missing_explain',
-                'element_id',
-            );
-
-            return createPreviewError({
-                title: phrase.preview_missing_title,
-                message: phrase.preview_missing_explain,
-                pre: `${phrase.element_id}: ${request.elementId}`,
-            });
-        }
-    }
-
-    if (request.type === PreviewRequestType.HashMismatch) {
-        const phrase = await usePhrases(
-            'preview_hash_mismatch_title',
-            'preview_hash_mismatch_explain',
-            'current_page_hash',
-            'expected_page_hash',
-        );
-
-        return {
-            type: PreviewDataType.Alert,
-            theme: PreviewThemeName.Warn,
-            title: phrase.preview_hash_mismatch_title,
-            message: phrase.preview_hash_mismatch_explain,
-            pre: `${phrase.current_page_hash}: ${request.currentHash}\n${phrase.expected_page_hash}: ${request.expectedHash}`,
-        };
-    }
-
-    for (const build of builders) {
-        const result = await build(request);
-        if (result) return result;
-    }
-
-    throw createPreviewError({
-        message: `Unable to build preview data for request!`,
-        pre: JSON.stringify(request, null, 4),
-    });
-}
+import { PreviewDataType, type PreviewData } from './data';
+import { createPreviewError } from './data/alert';
+import { PreviewRequestType, type PreviewRequest } from './request';
+import { PreviewThemeName } from './state';
+
+const builders = [
+    async (request: PreviewRequest) =>
+        (await import('./data/genericLink')).buildGenericLink(request),
+    async (request: PreviewRequest) =>
+        (await import('./data/pageLink')).buildPageLink(request),
+    async (request: PreviewRequest) =>
+        (await import('./data/unique')).buildUnique(request),
+];
+
+export async function buildPreviewData(
+    request: PreviewRequest,
+): Promise<PreviewData> {
+    if (request.type === PreviewRequestType.Data) return request.data;
+
+    if (request.type === PreviewRequestType.MissingElement) {
+        if (request.hashMismatch) {
+            const phrase = await usePhrases(
+                'preview_missing_title',
+                'preview_missing_explain_mismatch',
+                'element_id',
+                'current_page_hash',
+                'expected_page_hash',
+            );
+
+            return createPreviewError({
+                title: phrase.preview_missing_title,
+                message: phrase.preview_missing_explain_mismatch,
+                pre: `${phrase.element_id}: ${request.elementId}\n${phrase.current_page_hash}: ${request.hashMismatch.current}\n${phrase.expected_page_hash}: ${request.hashMismatch.expected}`,
+            });
+        } else {
+            const phrase = await usePhrases(
+                'preview_missing_title',
+                'preview_missing_explain',
+                'element_id',
+            );
+
+            return createPreviewError({
+                title: phrase.preview_missing_title,
+                message: phrase.preview_missing_explain,
+                pre: `${phrase.element_id}: ${request.elementId}`,
+            });
+        }
+    }
+
+    if (request.type === PreviewRequestType.HashMismatch) {
+        const phrase = await usePhrases(
+            'preview_hash_mismatch_title',
+            'preview_hash_mismatch_explain',
+            'current_page_hash',
+            'expected_page_hash',
+        );
+
+        return {
+            type: PreviewDataType.Alert,
+            theme: PreviewThemeName.Warn,
+            title: phrase.preview_hash_mismatch_title,
+            message: phrase.preview_hash_mismatch_explain,
+            pre: `${phrase.current_page_hash}: ${request.currentHash}\n${phrase.expected_page_hash}: ${request.expectedHash}`,
+        };
+    }
+
+    for (const build of builders) {
+        const result = await build(request);
+        if (result) return result;
+    }
+
+    throw createPreviewError({
+        message: `Unable to build preview data for request!`,
+        pre: JSON.stringify(request, null, 4),
+    });
+}

package/app/scripts/preview/data/alert.ts

@@ -1,19 +1,19 @@
-import { PreviewDataType, type PreviewDataBase } from '../data';
-import { PreviewThemeName } from '../state';
-
-export type AlertData = Partial<{
-    theme: PreviewThemeName;
-    title: string;
-    message: string;
-    pre: string;
-}>;
-
-export type PreviewDataAlert = PreviewDataBase & AlertData;
-
-export function createPreviewError(alertData: AlertData): PreviewDataAlert {
-    return {
-        type: PreviewDataType.Alert,
-        theme: PreviewThemeName.Error,
-        ...alertData,
-    };
-}
+import { PreviewDataType, type PreviewDataBase } from '../data';
+import { PreviewThemeName } from '../state';
+
+export type AlertData = Partial<{
+    theme: PreviewThemeName;
+    title: string;
+    message: string;
+    pre: string;
+}>;
+
+export type PreviewDataAlert = PreviewDataBase & AlertData;
+
+export function createPreviewError(alertData: AlertData): PreviewDataAlert {
+    return {
+        type: PreviewDataType.Alert,
+        theme: PreviewThemeName.Error,
+        ...alertData,
+    };
+}

package/app/scripts/preview/data/custom.ts

@@ -1,8 +1,8 @@
-import type { PreviewDataBase, PreviewDataType } from '../data';
-import type { PreviewFooter } from '../footer';
-
-export interface PreviewDataCustom extends PreviewDataBase {
-    type: PreviewDataType.Custom;
-    message: string;
-    footer?: PreviewFooter;
-}
+import type { PreviewDataBase, PreviewDataType } from '../data';
+import type { PreviewFooter } from '../footer';
+
+export interface PreviewDataCustom extends PreviewDataBase {
+    type: PreviewDataType.Custom;
+    message: string;
+    footer?: PreviewFooter;
+}

package/app/scripts/preview/data/genericLink.ts

@@ -1,24 +1,24 @@
-import { PreviewDataType, type PreviewDataBase } from '../data';
-import { PreviewRequestType, type PreviewRequest } from '../request';
-
-export interface PreviewDataGenericLink extends PreviewDataBase {
-    type: PreviewDataType.GenericLink;
-    external: boolean;
-    href: string;
-}
-
-export async function buildGenericLink(
-    request: PreviewRequest,
-): Promise<PreviewDataGenericLink> {
-    if (request.type !== PreviewRequestType.Link) return;
-
-    const { linkTarget } = request;
-
-    if (!['external', 'absolute'].includes(linkTarget.type)) return;
-
-    return {
-        type: PreviewDataType.GenericLink,
-        external: linkTarget.type === 'external',
-        href: linkTarget.href,
-    };
-}
+import { PreviewDataType, type PreviewDataBase } from '../data';
+import { PreviewRequestType, type PreviewRequest } from '../request';
+
+export interface PreviewDataGenericLink extends PreviewDataBase {
+    type: PreviewDataType.GenericLink;
+    external: boolean;
+    href: string;
+}
+
+export async function buildGenericLink(
+    request: PreviewRequest,
+): Promise<PreviewDataGenericLink> {
+    if (request.type !== PreviewRequestType.Link) return;
+
+    const { linkTarget } = request;
+
+    if (!['external', 'absolute'].includes(linkTarget.type)) return;
+
+    return {
+        type: PreviewDataType.GenericLink,
+        external: linkTarget.type === 'external',
+        href: linkTarget.href,
+    };
+}

package/app/scripts/preview/data/pageLink.ts

@@ -1,20 +1,23 @@
-import { PreviewDataType, type PreviewDataBase } from '../data';
-import { PreviewRequestType, type PreviewRequest } from '../request';
-import type { PreviewFooter } from '../footer';
-
-export interface PreviewDataPageLink extends PreviewDataBase {
-    type: PreviewDataType.PageLink;
-    footer: PreviewFooter;
-}
-
-export async function buildPageLink(
-    request: PreviewRequest,
-): Promise<PreviewDataPageLink> {
-    if (request.type !== PreviewRequestType.Link) return;
-
-    const { linkTarget } = request;
-
-    if (linkTarget.type !== 'page') return;
-
-    return await $fetch(`/api/preview/page${linkTarget._href}`);
-}
+import { PreviewDataType, type PreviewDataBase } from '../data';
+import { PreviewRequestType, type PreviewRequest } from '../request';
+import type { PreviewFooter } from '../footer';
+
+export interface PreviewDataPageLink extends PreviewDataBase {
+    type: PreviewDataType.PageLink;
+    footer: PreviewFooter;
+    description?: string;
+}
+
+export async function buildPageLink(
+    request: PreviewRequest,
+): Promise<PreviewDataPageLink> {
+    if (request.type !== PreviewRequestType.Link) return;
+
+    const { linkTarget } = request;
+
+    if (linkTarget.type !== 'page') return;
+
+    return await $fetch(`/api/preview/page${linkTarget._href}`, {
+        responseType: 'json',
+    });
+}

package/app/scripts/preview/data/unique.ts

@@ -1,70 +1,69 @@
-import type { BitranContent } from 'bitran';
-
-import type { BitranContext } from '@erudit/shared/bitran/context';
-
-import { PreviewDataType, type PreviewDataBase } from '../data';
-import type { PreviewFooter } from '../footer';
-import { PreviewRequestType, type PreviewRequest } from '../request';
-import { encodeBitranLocation } from '@erudit/shared/bitran/location';
-
-export interface PreviewDataUnique extends PreviewDataBase {
-    type: PreviewDataType.Unique;
-    productName: string;
-    bitran: {
-        context: BitranContext;
-        content: BitranContent;
-    };
-    footer: PreviewFooter;
-}
-
-export async function buildUnique(
-    request: PreviewRequest,
-): Promise<PreviewDataUnique> {
-    if (request.type !== PreviewRequestType.Link) return;
-
-    const { linkTarget } = request;
-
-    if (linkTarget.type !== 'unique') return;
-
-    const serverData = (await $fetch(
-        `/api/preview/unique/${encodeBitranLocation(linkTarget._absoluteStrLocation!)}`,
-    )) as any;
-    const productName = serverData.bitran.productName;
-    const customTitle = serverData.productTitle;
-
-    const icon = await useBitranElementIcon(productName);
-
-    const productPhraseName = await (async () => {
-        const elementPhrase = await useBitranElementLanguage(productName);
-        try {
-            return elementPhrase('_element_title');
-        } catch {
-            return productName;
-        }
-    })();
-
-    let secondary = serverData.context
-        .filter((i) => !i.hidden)
-        .map((i) => i.title)
-        .join(' / ');
-    secondary += customTitle
-        ? (secondary ? ' • ' : '') + productPhraseName
-        : '';
-
-    const primary = customTitle || productPhraseName || productName;
-
-    return {
-        type: PreviewDataType.Unique,
-        productName,
-        bitran: {
-            context: serverData.bitran.context,
-            content: serverData.bitran.content as any,
-        },
-        footer: {
-            iconSvg: icon,
-            primary,
-            secondary,
-            href: linkTarget._href,
-        },
-    };
-}
+import {
+    encodeBitranLocation,
+    parseBitranLocation,
+} from '@erudit-js/cog/schema';
+
+import type { RawBitranContent } from '@shared/bitran/content';
+
+import { PreviewDataType, type PreviewDataBase } from '../data';
+import type { PreviewFooter } from '../footer';
+import { PreviewRequestType, type PreviewRequest } from '../request';
+
+export interface PreviewDataUnique extends PreviewDataBase {
+    type: PreviewDataType.Unique;
+    elementName: string;
+    title: string;
+    rawBitranContent: RawBitranContent;
+    footer: PreviewFooter;
+}
+
+export async function buildUnique(
+    request: PreviewRequest,
+): Promise<PreviewDataUnique | undefined> {
+    if (request.type !== PreviewRequestType.Link) return;
+
+    const { linkTarget } = request;
+
+    if (linkTarget.type !== 'unique') return;
+
+    const serverData = await $fetch(
+        `/api/preview/unique/${encodeBitranLocation(linkTarget._absoluteStrLocation!)}`,
+        { responseType: 'json' },
+    );
+    const elementName = serverData.elementName;
+    const customTitle = serverData.title;
+
+    const icon = await useBitranElementIcon(elementName);
+
+    const productPhraseName = await (async () => {
+        const elementPhrase = await useBitranElementLanguage(elementName);
+        try {
+            return elementPhrase('_element_title');
+        } catch {
+            return elementName;
+        }
+    })();
+
+    let secondary = serverData.context
+        .filter((i) => !i.hidden)
+        .map((i) => i.title)
+        .join(' / ');
+    secondary += customTitle
+        ? (secondary ? ' • ' : '') + productPhraseName
+        : '';
+
+    const primary = customTitle || productPhraseName || elementName;
+
+    return {
+        type: PreviewDataType.Unique,
+        elementName: elementName,
+        title: customTitle || productPhraseName,
+        rawBitranContent: serverData.rawBitranContent as RawBitranContent,
+        footer: {
+            iconSvg: icon,
+            primary,
+            secondary,
+            href: linkTarget._href,
+        },
+    };
+}

package/app/scripts/preview/data.ts

@@ -1,24 +1,24 @@
-import type { PreviewDataAlert } from './data/alert';
-import type { PreviewDataCustom } from './data/custom';
-import type { PreviewDataGenericLink } from './data/genericLink';
-import type { PreviewDataPageLink } from './data/pageLink';
-import type { PreviewDataUnique } from './data/unique';
-
-export enum PreviewDataType {
-    Alert = 'alert',
-    Custom = 'custom',
-    GenericLink = 'generic-link',
-    PageLink = 'page-link',
-    Unique = 'unique',
-}
-
-export interface PreviewDataBase {
-    type: `${PreviewDataType}`;
-}
-
-export type PreviewData =
-    | PreviewDataAlert
-    | PreviewDataCustom
-    | PreviewDataGenericLink
-    | PreviewDataPageLink
-    | PreviewDataUnique;
+import type { PreviewDataAlert } from './data/alert';
+import type { PreviewDataCustom } from './data/custom';
+import type { PreviewDataGenericLink } from './data/genericLink';
+import type { PreviewDataPageLink } from './data/pageLink';
+import type { PreviewDataUnique } from './data/unique';
+
+export enum PreviewDataType {
+    Alert = 'alert',
+    Custom = 'custom',
+    GenericLink = 'generic-link',
+    PageLink = 'page-link',
+    Unique = 'unique',
+}
+
+export interface PreviewDataBase {
+    type: `${PreviewDataType}`;
+}
+
+export type PreviewData =
+    | PreviewDataAlert
+    | PreviewDataCustom
+    | PreviewDataGenericLink
+    | PreviewDataPageLink
+    | PreviewDataUnique;

package/app/scripts/preview/display.ts

@@ -1,37 +1,37 @@
-import type { Component } from 'vue';
-
-import { PreviewDataType, type PreviewData } from './data';
-
-import {
-    LazyPreviewDisplayAlert,
-    LazyPreviewDisplayCustom,
-    LazyPreviewDisplayGenericLink,
-    LazyPreviewDisplayPageLink,
-    LazyPreviewDisplayUnique,
-} from '#components';
-
-import { createPreviewError } from './data/alert';
-
-export interface PreviewDisplayProps<T extends PreviewData> {
-    data: T;
-}
-
-export function getPreviewDisplayComponent(data: PreviewData): Component {
-    switch (data.type) {
-        case PreviewDataType.Alert:
-            return LazyPreviewDisplayAlert;
-        case PreviewDataType.Custom:
-            return LazyPreviewDisplayCustom;
-        case PreviewDataType.GenericLink:
-            return LazyPreviewDisplayGenericLink;
-        case PreviewDataType.PageLink:
-            return LazyPreviewDisplayPageLink;
-        case PreviewDataType.Unique:
-            return LazyPreviewDisplayUnique;
-    }
-
-    throw createPreviewError({
-        message: `Unable to build preview data for request!`,
-        pre: JSON.stringify(data, null, 4),
-    });
-}
+import type { Component } from 'vue';
+
+import { PreviewDataType, type PreviewData } from './data';
+
+import {
+    LazyPreviewDisplayAlert,
+    LazyPreviewDisplayCustom,
+    LazyPreviewDisplayGenericLink,
+    LazyPreviewDisplayPageLink,
+    LazyPreviewDisplayUnique,
+} from '#components';
+
+import { createPreviewError } from './data/alert';
+
+export interface PreviewDisplayProps<T extends PreviewData> {
+    data: T;
+}
+
+export function getPreviewDisplayComponent(data: PreviewData): Component {
+    switch (data.type) {
+        case PreviewDataType.Alert:
+            return LazyPreviewDisplayAlert;
+        case PreviewDataType.Custom:
+            return LazyPreviewDisplayCustom;
+        case PreviewDataType.GenericLink:
+            return LazyPreviewDisplayGenericLink;
+        case PreviewDataType.PageLink:
+            return LazyPreviewDisplayPageLink;
+        case PreviewDataType.Unique:
+            return LazyPreviewDisplayUnique;
+    }
+
+    throw createPreviewError({
+        message: `Unable to build preview data for request!`,
+        pre: JSON.stringify(data, null, 4),
+    });
+}

package/app/scripts/preview/footer.ts

@@ -1,9 +1,9 @@
-import type { MyIconName } from '#my-icons';
-
-export type PreviewFooter = Partial<{
-    iconName: MyIconName;
-    iconSvg: string;
-    secondary: string;
-    primary: string;
-    href: string;
-}>;
+import type { MyIconName } from '#my-icons';
+
+export type PreviewFooter = Partial<{
+    iconName: MyIconName;
+    iconSvg: string;
+    secondary: string;
+    primary: string;
+    href: string;
+}>;