erudit 3.0.0-dev.9 → 4.0.0-dev.2

package/app/components/preview/display/Unique.vue

@@ -1,55 +0,0 @@
-<script lang="ts" setup>
-import { headingName } from '@erudit-js/bitran-elements/heading/shared';
-
-import type { PreviewDataUnique } from '@app/scripts/preview/data/unique';
-import type { PreviewDisplayProps } from '@app/scripts/preview/display';
-
-const { data } = defineProps<PreviewDisplayProps<PreviewDataUnique>>();
-
-const bitranTranspiler = await useBitranTranspiler();
-const root = await bitranTranspiler.parser.parse(data.bitran.content.biCode);
-</script>
-
-<template>
-    <PreviewDisplay :footer="data.footer">
-        <div
-            :class="[
-                $style.bitranPreviewContent,
-                data.productName === headingName && $style.heading,
-            ]"
-        >
-            <BitranContent
-                :content="{
-                    root,
-                    preRenderData: data.bitran.content.preRenderData,
-                }"
-                :context="data.bitran.context"
-            />
-        </div>
-    </PreviewDisplay>
-</template>
-
-<style lang="scss" module>
-.bitranPreviewContent {
-    position: relative;
-    padding: var(--gap) 0;
-}
-
-.heading {
-    max-height: 340px;
-    overflow: hidden;
-
-    &::after {
-        content: '';
-        position: absolute;
-        top: 0;
-        left: 0;
-        width: 100%;
-        height: 100%;
-        z-index: 10;
-        background: linear-gradient(to bottom, transparent, var(--bgAside) 95%);
-        pointer-events: none;
-        touch-action: none;
-    }
-}
-</style>

package/app/composables/bitran.ts

@@ -1,105 +0,0 @@
-import {
-    createPhraseCaller,
-    getDefaultRenderers as getDefaultBitranRenderers,
-    getElementIcon,
-    type ElementVueRenderers,
-} from '@bitran-js/renderer-vue';
-import {
-    defineBitranTranspiler,
-    type BitranTranspiler,
-    type ElementTranspilers,
-} from '@bitran-js/transpiler';
-import { eruditDefaultTranspilers } from '@erudit-js/bitran-elements/defaultTranspilers';
-import { eruditDefaultRenderers } from '@erudit-js/bitran-elements/defaultRenderers';
-
-import eruditConfig from '#erudit/config';
-import bitranConfig from '#erudit/client/bitran';
-
-let bitranTranspiler!: BitranTranspiler;
-let bitranRenderers!: ElementVueRenderers;
-
-globalThis.useEruditConfig = () => eruditConfig;
-
-//
-// Transpiler
-//
-
-export async function useBitranTranspiler() {
-    if (bitranTranspiler) return bitranTranspiler;
-
-    const projectTranspilers = await getProjectTranspilers();
-
-    bitranTranspiler = defineBitranTranspiler({
-        ...projectTranspilers,
-        ...eruditDefaultTranspilers,
-    });
-
-    return bitranTranspiler;
-}
-
-async function getProjectTranspilers(): Promise<ElementTranspilers> {
-    const bitranElements = bitranConfig.elements;
-
-    if (!bitranElements) return {};
-
-    const projectTranspilers: ElementTranspilers = {};
-    for (const [name, bitranElement] of Object.entries(bitranElements))
-        projectTranspilers[name] = await bitranElement.transpiler();
-
-    return projectTranspilers;
-}
-
-//
-// Renderers
-//
-
-export async function useBitranRenderers() {
-    if (bitranRenderers) return bitranRenderers;
-
-    const projectRenderers = await getProjectRenderers();
-
-    // @ts-ignore
-    bitranRenderers = {
-        ...projectRenderers,
-        ...eruditDefaultRenderers,
-    };
-
-    return bitranRenderers!;
-}
-
-async function getProjectRenderers() {
-    const bitranElements = bitranConfig.elements;
-
-    if (!bitranElements) return {};
-
-    const projectRenderers: ElementVueRenderers = {};
-    for (const [name, bitranElement] of Object.entries(bitranElements))
-        projectRenderers[name] = await bitranElement.renderer();
-
-    return projectRenderers;
-}
-
-//
-// Utils
-//
-
-export async function useBitranElementRenderer(productName: string) {
-    const renderer =
-        (await useBitranRenderers())[productName] ||
-        getDefaultBitranRenderers()[productName];
-
-    if (!renderer)
-        throw new Error(`Missing Bitran product render "${productName}"!`);
-
-    return renderer;
-}
-
-export async function useBitranElementIcon(productName: string) {
-    const renderer = await useBitranElementRenderer(productName);
-    return await getElementIcon(renderer);
-}
-
-export async function useBitranElementLanguage(productName: string) {
-    const renderer = await useBitranElementRenderer(productName);
-    return await createPhraseCaller(renderer, eruditConfig?.language || 'en');
-}

package/app/composables/bitranContent.ts

@@ -1,51 +0,0 @@
-import type { ShallowRef } from 'vue';
-import type { BitranContent } from '@bitran-js/renderer-vue';
-import {
-    encodeBitranLocation,
-    stringifyBitranLocation,
-    type BitranLocation,
-} from '@erudit-js/cog/schema';
-import type { StringBitranContent } from '@erudit/shared/bitran/stringContent';
-
-export async function useBitranContent(
-    location: Ref<BitranLocation | undefined>,
-) {
-    const nuxtApp = useNuxtApp();
-    const content = shallowRef<BitranContent>();
-
-    let contentPromise: Promise<ShallowRef<BitranContent>>;
-
-    watchEffect(() => {
-        if (!location.value) {
-            // @ts-ignore
-            contentPromise = (() => {
-                content.value = undefined;
-                return content;
-            })();
-        }
-
-        const apiRoute = `/api/bitran/content/${encodeBitranLocation(stringifyBitranLocation(location.value!))}`;
-        nuxtApp.runWithContext(() => prerenderRoutes(apiRoute));
-
-        // @ts-ignore
-        contentPromise = (async () => {
-            const stringContent = (await $fetch(apiRoute, {
-                responseType: 'json',
-            })) as StringBitranContent;
-
-            const bitranTranspiler = await useBitranTranspiler();
-            const root = await bitranTranspiler.parser.parse(
-                stringContent.biCode,
-            );
-
-            content.value = {
-                root,
-                preRenderData: stringContent.preRenderData,
-            };
-
-            return content;
-        })();
-    });
-
-    return contentPromise!;
-}

package/app/composables/bitranLocation.ts

@@ -1,7 +0,0 @@
-import { locationFromPath, type BitranLocation } from '@erudit-js/cog/schema';
-
-export function useBitranLocation(): ComputedRef<BitranLocation | undefined> {
-    const route = useRoute();
-
-    return computed(() => locationFromPath(route.path));
-}

package/app/composables/contentData.ts

@@ -1,36 +0,0 @@
-import type { ContentData } from '@shared/content/data';
-
-export function useContentData<T extends ContentData>() {
-    const nuxtApp = useNuxtApp();
-    const contentRoute = useContentRoute();
-
-    const payloadKey = 'content-data';
-    const payload =
-        (nuxtApp.static.data[payloadKey] ||=
-        nuxtApp.payload.data[payloadKey] ||=
-            {});
-
-    const data = ref<T>();
-    let promise: Promise<typeof data> | undefined;
-
-    watchEffect(() => {
-        // @ts-ignore
-        promise = (async () => {
-            if (!contentRoute.value) {
-                data.value = undefined;
-                return;
-            }
-
-            const contentId = contentRoute.value.contentId;
-
-            const payloadValue = (payload[contentId] ||= await $fetch(
-                '/api/content/data',
-                { query: { contentId } },
-            ));
-            data.value = payloadValue as T;
-            return data;
-        })();
-    });
-
-    return promise as any as Promise<Ref<T>>;
-}

package/app/composables/contentPage.ts

@@ -1,157 +0,0 @@
-import eruditConfig from '#erudit/config';
-
-import { createOgImageTags, defaultOgImage } from '@app/scripts/og';
-import type { ContentData } from '@shared/content/data';
-
-export function useContentPage(contentData: Ref<ContentData>) {
-    const contentRoute = useContentRoute();
-    const siteUrl = useSiteUrl();
-    const favicon = useFavicon();
-
-    const phrasePromise = usePhrases(
-        'article',
-        'summary',
-        'practice',
-        'site_info_title',
-        'seo_article_description',
-        'seo_summary_description',
-        'seo_practice_description',
-    );
-
-    //
-    // Favicon
-    //
-
-    const contentFavicon = () => {
-        setTimeout(() => {
-            const newFavicon = (() => {
-                switch (contentRoute.value?.type) {
-                    case 'topic':
-                        const topicPart = contentRoute.value.topicPart;
-                        return (
-                            eruditConfig.site?.favicon?.[topicPart] ||
-                            eruditAsset(`favicon/${topicPart}.svg`)
-                        );
-                }
-
-                return defaultFavicon;
-            })();
-
-            favicon.value = newFavicon;
-        }, 500);
-    };
-
-    //
-    // SEO
-    //
-
-    let seoTitlePromise: Promise<void>, seoDescriptionPromise: Promise<void>;
-
-    const seo = {
-        title: ref<string>(),
-        description: ref<string>(),
-    };
-
-    const setupSeoTitle = () => {
-        seoTitlePromise = (async () => {
-            const phrase = await phrasePromise;
-
-            let title: string = '';
-            title +=
-                contentData.value.generic?.seo?.title ||
-                contentData.value.generic.title ||
-                contentData.value.generic.contentId.split('/').pop();
-
-            if (contentData.value.type !== 'book') {
-                const bookTitle = contentData.value?.bookTitle;
-                title += bookTitle ? ` | ${bookTitle}` : '';
-            }
-
-            if (contentRoute.value!.type === 'topic') {
-                const topicPart = contentRoute.value!.topicPart;
-
-                if (topicPart !== 'article') title += ` | ${phrase[topicPart]}`;
-            }
-
-            title +=
-                ' - ' +
-                (eruditConfig.seo?.title ||
-                    eruditConfig.site?.title ||
-                    phrase.site_info_title);
-
-            seo.title.value = title;
-        })();
-    };
-
-    const setupSeoDescription = () => {
-        seoDescriptionPromise = (async () => {
-            const phrase = await phrasePromise;
-            const customDescription =
-                contentData.value.generic?.seo?.description ||
-                contentData.value.generic?.description;
-
-            if (customDescription) {
-                seo.description.value = customDescription;
-                return;
-            }
-
-            if (contentRoute.value!.type === 'topic') {
-                const phraseFunc =
-                    phrase[`seo_${contentRoute.value!.topicPart}_description`];
-                seo.description.value = phraseFunc(
-                    contentData.value.generic?.seo?.title ||
-                        contentData.value.generic.title!,
-                );
-                return;
-            }
-
-            seo.description.value = '';
-        })();
-    };
-
-    useSeoMeta({
-        // @ts-ignore
-        title: seo.title,
-        ogTitle: seo.title,
-        description: seo.description,
-        ogDescription: seo.description,
-    });
-
-    const meta = computed(() => {
-        return [
-            ...createOgImageTags(siteUrl, defaultOgImage),
-            ...(contentData.value.generic?.ogImage
-                ? createOgImageTags(siteUrl, contentData.value.generic?.ogImage)
-                : []),
-        ];
-    });
-
-    useHead({
-        meta,
-    });
-
-    //
-    //
-    //
-
-    watchEffect(() => {
-        setupSeoTitle();
-        setupSeoDescription();
-    });
-
-    onMounted(() => {
-        watchEffect(() => {
-            contentFavicon();
-        });
-    });
-
-    onBeforeUnmount(() => {
-        favicon.value = defaultFavicon;
-    });
-
-    //
-    //
-    //
-
-    return Promise.all([seoTitlePromise!, seoDescriptionPromise!]);
-}

package/app/composables/contentRoute.ts

@@ -1,45 +0,0 @@
-import type { ContentType, TopicPart } from '@erudit-js/cog/schema';
-
-interface ContentRouteBase {
-    type: ContentType;
-    contentId: string;
-}
-
-interface TopicRoute extends ContentRouteBase {
-    type: 'topic';
-    topicPart: TopicPart;
-}
-
-interface ContentRoute extends ContentRouteBase {
-    type: Exclude<ContentType, 'topic'>;
-}
-
-export function useContentRoute(): ComputedRef<
-    TopicRoute | ContentRoute | undefined
-> {
-    const route = useRoute();
-    return computed(() => {
-        const match = route.path.match(/\/(.+?)\/(.+)/);
-
-        if (!match || !match[1] || !match[2]) return undefined;
-
-        switch (match[1]) {
-            case 'article':
-            case 'summary':
-            case 'practice':
-                return <TopicRoute>{
-                    type: 'topic',
-                    contentId: match[2],
-                    topicPart: match[1],
-                };
-            case 'group':
-            case 'book':
-                return <ContentRoute>{
-                    type: match[1],
-                    contentId: match[2],
-                };
-        }
-
-        return undefined;
-    });
-}

package/app/composables/darkMagic.ts

@@ -1,24 +0,0 @@
-declare let Ya: any;
-
-const getElementId = (bannerId: string) => {
-    return `DarkMagic_${bannerId}`;
-};
-
-const registerBanner = (bannerId: string) => {
-    const { binaryTheme } = useTheme();
-
-    (window['yaContextCb'] ||= []).push(() => {
-        Ya.Context.AdvManager.render({
-            renderTo: getElementId(bannerId),
-            blockId: bannerId,
-            darkTheme: binaryTheme.value === 'dark',
-        });
-    });
-};
-
-export function useDarkMagic() {
-    return {
-        getElementId,
-        registerBanner,
-    };
-}

package/app/composables/externalApi.ts

@@ -1,63 +0,0 @@
-import type { EruditConfigDebug } from '@erudit-js/cog/schema';
-
-import eruditConfig from '#erudit/config';
-
-function useFakeUrl(
-    fakeApiTarget: keyof EruditConfigDebug['fakeApi'],
-): boolean {
-    return eruditConfig.debug?.fakeApi?.[fakeApiTarget] ?? import.meta.dev;
-}
-
-function getPayload() {
-    const nuxt = useNuxtApp();
-    const payloadKey = 'external-api';
-    const payload =
-        (nuxt.static.data[payloadKey] ||=
-        nuxt.payload.data[payloadKey] ||=
-            {});
-
-    return payload;
-}
-
-export async function useExternalApiLanguages() {
-    const sharedUrl = eruditConfig.repository?.sharedUrl;
-    if (!sharedUrl) return {};
-
-    const payload = getPayload();
-    const fake = useFakeUrl('languages');
-
-    if (fake) {
-        payload.languages ||= await $fetch('/api/fake/shared/languages');
-    } else {
-        payload.languages ||= await $fetch(
-            `https://api.github.com/repos/${sharedUrl}/contents/languages.json`,
-            {
-                headers: { Accept: 'application/vnd.github.v3.raw' },
-                responseType: 'json',
-                //transform: (response: string) => JSON.parse(response),
-            },
-        );
-    }
-
-    return payload.languages;
-}
-
-export async function useExternalApiRepository() {
-    const repositoryName = eruditConfig.repository?.name;
-    const repositoryBranch = eruditConfig.repository?.branch;
-
-    if (!repositoryName || !repositoryBranch) return undefined;
-
-    const payload = getPayload();
-    const fake = useFakeUrl('repository');
-
-    if (fake) {
-        payload.repository ||= await $fetch('/api/fake/content');
-    } else {
-        payload.repository ||= await $fetch(
-            `https://api.github.com/repos/${repositoryName}/branches/${repositoryBranch}`,
-        );
-    }
-
-    return payload.repository;
-}

package/app/composables/majorPane.ts

@@ -1,60 +0,0 @@
-import type { Component } from 'vue';
-
-import type { MyIconName } from '#my-icons';
-
-import Nav from '@app/components/aside/major/panes/nav/Nav.vue';
-import Pages from '@app/components/aside/major/panes/Pages.vue';
-import Search from '@app/components/aside/major/panes/Search.vue';
-import Language from '@app/components/aside/major/panes/Language.vue';
-import Other from '@app/components/aside/major/panes/other/Other.vue';
-
-interface MajorPane {
-    icon: MyIconName;
-    phrase: EruditPhraseId;
-    content: Component;
-}
-
-function definePane<TPane extends MajorPane>(pane: TPane) {
-    return pane;
-}
-
-export const majorPanes = {
-    index: definePane({ icon: 'book', phrase: 'index', content: Nav }),
-    pages: definePane({ icon: 'file-lines', phrase: 'pages', content: Pages }),
-    search: definePane({ icon: 'search', phrase: 'search', content: Search }),
-    language: definePane({
-        icon: 'globe',
-        phrase: 'language',
-        content: Language,
-    }),
-    other: definePane({
-        icon: 'ellipsis-vertical',
-        phrase: 'other',
-        content: Other,
-    }),
-};
-
-function getPaneOrder(paneKey: MajorPaneKey) {
-    return Object.keys(majorPanes).indexOf(paneKey);
-}
-
-export type MajorPaneKey = keyof typeof majorPanes;
-
-export function useMajorPane() {
-    const route = useRoute();
-
-    const activePane = useState<MajorPaneKey>('major-pane', () => {
-        switch (route.path) {
-            case '/members':
-                return 'pages';
-            default:
-                return 'index';
-        }
-    });
-
-    return {
-        panes: majorPanes,
-        activePane,
-        getPaneOrder,
-    };
-}