erudit 3.0.0-dev.1 → 3.0.0-dev.10

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

@@ -1,20 +1,22 @@
-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;
+}
+
+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,72 @@
-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,
+    type BitranContext,
+} from '@erudit-js/cog/schema';
+
+import { PreviewDataType, type PreviewDataBase } from '../data';
+import type { PreviewFooter } from '../footer';
+import { PreviewRequestType, type PreviewRequest } from '../request';
+import type { StringBitranContent } from '@erudit/shared/bitran/stringContent';
+
+export interface PreviewDataUnique extends PreviewDataBase {
+    type: PreviewDataType.Unique;
+    productName: string;
+    bitran: {
+        context: BitranContext;
+        content: StringBitranContent;
+    };
+    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!)}`,
+        { responseType: 'json' },
+    )) 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,
+        },
+    };
+}

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

package/app/scripts/preview/request.ts

@@ -1,51 +1,51 @@
-import type { LinkData } from '@erudit/shared/bitran/link/shared';
-import type { LinkTarget } from '@erudit/shared/bitran/link/target';
-
-import type { PreviewData } from './data';
-
-export enum PreviewRequestType {
-    Link = 'link',
-    Data = 'data',
-    MissingElement = 'missing-element',
-    HashMismatch = 'hash-mismatch',
-}
-
-export interface PreviewRequestData extends PreviewRequestBase {
-    type: PreviewRequestType.Data;
-    data: PreviewData;
-}
-
-export interface PreviewRequestLink extends PreviewRequestBase {
-    type: PreviewRequestType.Link;
-    linkData: LinkData;
-    linkTarget: LinkTarget;
-}
-
-export interface PreviewRequestMissingElement extends PreviewRequestBase {
-    type: PreviewRequestType.MissingElement;
-    elementId: string;
-    hashMismatch?: {
-        current: string;
-        expected: string;
-    };
-}
-
-export interface PreviewRequestHashMismatch extends PreviewRequestBase {
-    type: PreviewRequestType.HashMismatch;
-    currentHash: string;
-    expectedHash: string;
-}
-
-export type PreviewRequest =
-    | PreviewRequestData
-    | PreviewRequestLink
-    | PreviewRequestMissingElement
-    | PreviewRequestHashMismatch;
-
-//
-//
-//
-
-interface PreviewRequestBase {
-    type: `${PreviewRequestType}`;
-}
+import type { LinkData } from '@erudit/shared/bitran/link/shared';
+import type { LinkTarget } from '@erudit/shared/bitran/link/target';
+
+import type { PreviewData } from './data';
+
+export enum PreviewRequestType {
+    Link = 'link',
+    Data = 'data',
+    MissingElement = 'missing-element',
+    HashMismatch = 'hash-mismatch',
+}
+
+export interface PreviewRequestData extends PreviewRequestBase {
+    type: PreviewRequestType.Data;
+    data: PreviewData;
+}
+
+export interface PreviewRequestLink extends PreviewRequestBase {
+    type: PreviewRequestType.Link;
+    linkData: LinkData;
+    linkTarget: LinkTarget;
+}
+
+export interface PreviewRequestMissingElement extends PreviewRequestBase {
+    type: PreviewRequestType.MissingElement;
+    elementId: string;
+    hashMismatch?: {
+        current: string;
+        expected: string;
+    };
+}
+
+export interface PreviewRequestHashMismatch extends PreviewRequestBase {
+    type: PreviewRequestType.HashMismatch;
+    currentHash: string;
+    expectedHash: string;
+}
+
+export type PreviewRequest =
+    | PreviewRequestData
+    | PreviewRequestLink
+    | PreviewRequestMissingElement
+    | PreviewRequestHashMismatch;
+
+//
+//
+//
+
+interface PreviewRequestBase {
+    type: `${PreviewRequestType}`;
+}

package/app/scripts/preview/state.ts

@@ -1,63 +1,63 @@
-import { objectsEqual } from '@shared/utils/objectsEqual';
-import { PreviewRequestType, type PreviewRequest } from './request';
-
-export enum PreviewThemeName {
-    Error = 'error',
-    Warn = 'warn',
-    Success = 'success',
-    Brand = 'brand',
-}
-
-//
-
-const _request = ref<PreviewRequest>();
-const _visible = ref(false);
-const _history = ref<PreviewRequest[]>([]);
-const _theme = ref<PreviewThemeName>();
-const _blinki = ref(0);
-
-//
-
-export const previewRequest = readonly(_request);
-export const previewVisible = readonly(_visible);
-export const previewTheme = readonly(_theme);
-export const previewBlinkTrigger = readonly(_blinki);
-
-export const hasPreviewHistory = computed(() => _history.value.length > 0);
-
-export function showPreviousPreview() {
-    if (!hasPreviewHistory.value) return;
-
-    _request.value = _history.value.pop();
-}
-
-export function showPreview(request: PreviewRequest) {
-    if (objectsEqual(_request.value, request)) {
-        if (_visible.value) _blinki.value++;
-        else _visible.value = true;
-        return;
-    }
-
-    if (_request.value) _history.value.push(_request.value);
-
-    _request.value = request;
-    _visible.value = true;
-}
-
-export function closePreview() {
-    _visible.value = false;
-    _request.value = undefined;
-    _history.value.length = 0;
-}
-
-export function togglePreview(visible?: boolean) {
-    _visible.value = visible === undefined ? !_visible.value : visible;
-}
-
-export function setPreviewTheme(newTheme: PreviewThemeName) {
-    _theme.value = newTheme;
-}
-
-export function unsetPreviewTheme() {
-    _theme.value = undefined;
-}
+import { objectsEqual } from '@shared/utils/objectsEqual';
+import { PreviewRequestType, type PreviewRequest } from './request';
+
+export enum PreviewThemeName {
+    Error = 'error',
+    Warn = 'warn',
+    Success = 'success',
+    Brand = 'brand',
+}
+
+//
+
+const _request = ref<PreviewRequest>();
+const _visible = ref(false);
+const _history = ref<PreviewRequest[]>([]);
+const _theme = ref<PreviewThemeName>();
+const _blinki = ref(0);
+
+//
+
+export const previewRequest = readonly(_request);
+export const previewVisible = readonly(_visible);
+export const previewTheme = readonly(_theme);
+export const previewBlinkTrigger = readonly(_blinki);
+
+export const hasPreviewHistory = computed(() => _history.value.length > 0);
+
+export function showPreviousPreview() {
+    if (!hasPreviewHistory.value) return;
+
+    _request.value = _history.value.pop();
+}
+
+export function showPreview(request: PreviewRequest) {
+    if (objectsEqual(_request.value, request)) {
+        if (_visible.value) _blinki.value++;
+        else _visible.value = true;
+        return;
+    }
+
+    if (_request.value) _history.value.push(_request.value);
+
+    _request.value = request;
+    _visible.value = true;
+}
+
+export function closePreview() {
+    _visible.value = false;
+    _request.value = undefined;
+    _history.value.length = 0;
+}
+
+export function togglePreview(visible?: boolean) {
+    _visible.value = visible === undefined ? !_visible.value : visible;
+}
+
+export function setPreviewTheme(newTheme: PreviewThemeName) {
+    _theme.value = newTheme;
+}
+
+export function unsetPreviewTheme() {
+    _theme.value = undefined;
+}

package/app/styles/_immediate.css

@@ -1,7 +1,7 @@
-/* Instant color theme setup */
-:root {
-    color-scheme: light;
-}
-:root[data-theme='dark'] {
-    color-scheme: dark;
-}
+/* Instant color theme setup */
+:root {
+    color-scheme: light;
+}
+:root[data-theme='dark'] {
+    color-scheme: dark;
+}

package/app/styles/_util.scss

@@ -1,43 +1,43 @@
-@mixin transition($properties...) {
-    transition: all var(--transitionSpeed) var(--transitionFunction);
-    transition-property: $properties;
-}
-
-@mixin dark {
-    :root[data-theme='dark'] & {
-        @content;
-    }
-}
-
-@mixin hoverLink {
-    cursor: pointer;
-    color: inherit;
-    text-decoration: underline;
-    text-decoration-color: transparent;
-    @include transition(text-decoration-color);
-
-    &:hover {
-        text-decoration: underline;
-    }
-}
-
-@mixin scroll {
-    -webkit-overflow-scrolling: auto;
-
-    &::-webkit-scrollbar {
-        -webkit-appearance: none;
-        height: 5px;
-        width: 5px;
-    }
-
-    &::-webkit-scrollbar-thumb {
-        background: var(--scrollbar);
-        &:hover {
-            background: color-mix(in srgb, var(--scrollbar), var(--invert) 15%);
-        }
-    }
-
-    &::-webkit-scrollbar-corner {
-        background: var(--border);
-    }
-}
+@mixin transition($properties...) {
+    transition: all var(--transitionSpeed) var(--transitionFunction);
+    transition-property: $properties;
+}
+
+@mixin dark {
+    :root[data-theme='dark'] & {
+        @content;
+    }
+}
+
+@mixin hoverLink {
+    cursor: pointer;
+    color: inherit;
+    text-decoration: underline;
+    text-decoration-color: transparent;
+    @include transition(text-decoration-color);
+
+    &:hover {
+        text-decoration: underline;
+    }
+}
+
+@mixin scroll {
+    -webkit-overflow-scrolling: auto;
+
+    &::-webkit-scrollbar {
+        -webkit-appearance: none;
+        height: 5px;
+        width: 5px;
+    }
+
+    &::-webkit-scrollbar-thumb {
+        background: var(--scrollbar);
+        &:hover {
+            background: color-mix(in srgb, var(--scrollbar), var(--invert) 15%);
+        }
+    }
+
+    &::-webkit-scrollbar-corner {
+        background: var(--border);
+    }
+}