erudit 3.0.0-dev.23 → 3.0.0-dev.25

package/app/composables/adsAllowed.ts

@@ -1,11 +0,0 @@
-import eruditConfig from '#erudit/config';
-
-export function adsAllowed() {
-    if (typeof eruditConfig?.debug?.ads === 'undefined') {
-        return import.meta.dev ? false : true;
-    } else if (!Boolean(eruditConfig?.debug?.ads)) {
-        return false;
-    }
-
-    return true;
-}

package/app/composables/asset.ts

@@ -1,12 +0,0 @@
-/**
- * @param path Path relative to `PROJECT_DIR`
- */
-export function useAssetRoute() {
-    const useBaseUrl = useBaseUrlPath();
-    return (path: string) => {
-        if (!path.startsWith('/asset/')) {
-            path = '/asset/' + path.replace(/^\/+/, '');
-        }
-        return useBaseUrl(path);
-    };
-}

package/app/composables/bitran.ts

@@ -1,108 +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 type { EruditBitranElements } from '@erudit-js/cog/schema';
-
-import eruditConfig from '#erudit/config';
-import getBitranElements from '#erudit/bitran/app';
-
-let elements!: EruditBitranElements;
-let transpilers!: ElementTranspilers;
-let renderers!: ElementVueRenderers;
-
-let bitranTranspiler!: BitranTranspiler;
-let bitranRenderers!: ElementVueRenderers;
-
-//
-//
-//
-
-async function getElements() {
-    if (!elements) elements = await getBitranElements();
-
-    return elements;
-}
-
-async function getTranspilers() {
-    if (!transpilers) {
-        const elements = await getElements();
-        transpilers = Object.fromEntries(
-            Object.entries(elements).map(([key, item]) => [
-                key,
-                item.transpiler,
-            ]),
-        );
-    }
-    return transpilers;
-}
-
-async function getRenderers() {
-    if (!renderers) {
-        const elements = await getElements();
-        renderers = Object.fromEntries(
-            Object.entries(elements).map(([key, item]) => [key, item.renderer]),
-        );
-    }
-    return renderers;
-}
-
-//
-// Transpiler
-//
-
-export async function useBitranTranspiler() {
-    if (bitranTranspiler) return bitranTranspiler;
-
-    bitranTranspiler = defineBitranTranspiler({
-        ...(await getTranspilers()),
-    });
-
-    return bitranTranspiler;
-}
-
-//
-// Renderers
-//
-
-export async function useBitranRenderers() {
-    if (bitranRenderers) return bitranRenderers;
-
-    bitranRenderers = {
-        ...(await getRenderers()),
-    };
-
-    return bitranRenderers!;
-}
-
-//
-// Utils
-//
-
-export async function useBitranElementRenderer(productName: string) {
-    const renderer =
-        (await getRenderers())[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/bitranLocation.ts

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

package/app/composables/contentData.ts

@@ -1,38 +0,0 @@
-import { trailingSlash } from '@erudit/utils/url';
-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 dataKey = trailingSlash(contentRoute.value.contentId, false);
-
-            const payloadValue = (payload[dataKey] ||= await $fetch(
-                '/api/content/data',
-                { query: { contentId: dataKey } },
-            ));
-
-            data.value = payloadValue as T;
-            return data;
-        })();
-    });
-
-    return promise as any as Promise<Ref<T>>;
-}

package/app/composables/contentPage.ts

@@ -1,169 +0,0 @@
-import eruditConfig from '#erudit/config';
-
-import { normalizeText } from '@erudit/utils/normalize';
-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 (contentRoute.value!.type === 'topic') {
-                const topicPart = contentRoute.value!.topicPart;
-                if (topicPart !== 'article') title += ` | ${phrase[topicPart]}`;
-            }
-
-            // Add book title in the middle section only if not using it as the site title
-            if (
-                contentData.value.type !== 'book' &&
-                contentData.value?.bookTitle &&
-                !eruditConfig.content?.bookSiteTitle
-            ) {
-                title += ` | ${contentData.value.bookTitle}`;
-            }
-
-            // Choose the site title based on configuration
-            const siteTitle =
-                contentData.value.type !== 'book' &&
-                eruditConfig.content?.bookSiteTitle &&
-                contentData.value?.bookTitle
-                    ? contentData.value.bookTitle
-                    : eruditConfig.seo?.title ||
-                      eruditConfig.site?.title ||
-                      phrase.site_info_title;
-
-            title += ' - ' + siteTitle;
-
-            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 = normalizeText(customDescription);
-                return;
-            }
-
-            if (contentRoute.value!.type === 'topic') {
-                const phraseFunc =
-                    phrase[`seo_${contentRoute.value!.topicPart}_description`];
-                seo.description.value = normalizeText(
-                    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,69 +0,0 @@
-import type { EruditConfigDebug } from '@erudit-js/cog/schema';
-
-import eruditConfig from '#erudit/config';
-
-let languagesCache: any;
-let repositoryCache: any;
-
-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 ||= languagesCache ||= await $fetch(
-            '/api/fake/shared/languages',
-        );
-    } else {
-        payload.languages ||= languagesCache ||= 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 ||= repositoryCache ||=
-            await $fetch('/api/fake/content');
-    } else {
-        payload.repository ||= repositoryCache ||= await $fetch(
-            `https://api.github.com/repos/${repositoryName}/branches/${repositoryBranch}`,
-        );
-    }
-
-    return payload.repository;
-}

package/app/composables/head.ts

@@ -1,24 +0,0 @@
-import eruditConfig from '#erudit/config';
-
-interface EruditHead {
-    title: string;
-    description?: string;
-}
-
-export function useEruditHead(head: EruditHead) {
-    const siteTitle = getSiteTitle();
-    const title = head.title ? `${head.title} - ${siteTitle}` : siteTitle;
-
-    useHead({ title });
-
-    useSeoMeta({
-        title,
-        ogTitle: title,
-        description: head.description,
-        ogDescription: head.description,
-    });
-}
-
-function getSiteTitle() {
-    return eruditConfig.seo?.title || eruditConfig.site?.title || 'Erudit';
-}

package/app/composables/majorPane.ts

@@ -1,62 +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 (true) {
-            case route.path.startsWith('/contributors'):
-            case route.path.startsWith('/contributor/'):
-            case route.path === '/sponsors/':
-                return 'pages';
-            default:
-                return 'index';
-        }
-    });
-
-    return {
-        panes: majorPanes,
-        activePane,
-        getPaneOrder,
-    };
-}

package/app/pages/_test/preview.vue

@@ -1,110 +0,0 @@
-<script lang="ts" setup>
-import { PreviewDataType } from '@app/scripts/preview/data';
-import { createPreviewError } from '@app/scripts/preview/data/alert';
-import { PreviewRequestType } from '@app/scripts/preview/request';
-import {
-    PreviewThemeName,
-    showPreview,
-    togglePreview,
-} from '@app/scripts/preview/state';
-
-function showCustom() {
-    showPreview({
-        type: PreviewRequestType.Data,
-        data: {
-            type: PreviewDataType.Custom,
-            message: 'This is custom message for preview!',
-            footer: {
-                //iconName: 'arrow-left',
-                iconSvg:
-                    '<svg viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"><g id="SVGRepo_bgCarrier" stroke-width="0"></g><g id="SVGRepo_tracerCarrier" stroke-linecap="round" stroke-linejoin="round"></g><g id="SVGRepo_iconCarrier"> <path fill-rule="evenodd" clip-rule="evenodd" d="M6.42436 0H9.57565L14.995 16H11.8276L10.8115 13H5.18855L4.17242 16H1.005L6.42436 0ZM6.20468 10H9.79533L8 4.69952L6.20468 10Z"></path> </g></svg>',
-                secondary: 'Secondary raw text',
-                primary: 'Primary raw text',
-                href: 'https://google.com',
-            },
-        },
-    });
-}
-
-function showAlert(theme: PreviewThemeName) {
-    showPreview({
-        type: PreviewRequestType.Data,
-        data: createPreviewError({
-            theme,
-            message: 'This is message!',
-            title: 'Custom Title',
-            pre: JSON.stringify(
-                {
-                    foo: 1337,
-                    bar: 'Some text',
-                },
-                null,
-                4,
-            ),
-        }),
-    });
-}
-</script>
-
-<template>
-    <button @click="() => togglePreview()">Toggle Preview</button>
-    <div>
-        Show:
-        <br />
-        <button :class="$style.button" @click="showCustom">Custom</button>
-        <br />
-        <button
-            :class="$style.button"
-            v-for="theme in PreviewThemeName"
-            @click="() => showAlert(theme)"
-        >
-            Alert {{ theme }}
-        </button>
-        <br />
-        <button
-            :class="$style.button"
-            @click="
-                showPreview({
-                    type: PreviewRequestType.MissingElement,
-                    elementId: 'foo-id',
-                })
-            "
-        >
-            Missing element
-        </button>
-        <button
-            :class="$style.button"
-            @click="
-                showPreview({
-                    type: PreviewRequestType.MissingElement,
-                    elementId: 'foo-id',
-                    hashMismatch: { current: 'bar', expected: 'baz' },
-                })
-            "
-        >
-            Missing element + hash mismatch
-        </button>
-        <br />
-        <button
-            :class="$style.button"
-            @click="
-                showPreview({
-                    type: PreviewRequestType.HashMismatch,
-                    currentHash: 'foo',
-                    expectedHash: 'bar',
-                })
-            "
-        >
-            Hash mismatch
-        </button>
-    </div>
-</template>
-
-<style lang="scss" module>
-.button {
-    border: 2px solid var(--border);
-    border-radius: 3px;
-    padding: 3px;
-    margin: 3px;
-}
-</style>

package/app/pages/practice/[...practice].vue

@@ -1,3 +0,0 @@
-<template>
-    <MainTopic />
-</template>