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

package/app/composables/contentPage.ts

@@ -1,156 +1,157 @@
-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!]);
-}
+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 +1,45 @@
-import type { ContentType, TopicPart } from 'erudit-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;
-    });
-}
+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 +1,24 @@
-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,
-    };
-}
+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 +1,63 @@
-import type { EruditConfigDebug } from 'erudit-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;
-}
+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/favicon.ts

@@ -1,8 +1,8 @@
-import eruditConfig from '#erudit/config';
-
-export const defaultFavicon =
-    eruditConfig.site?.favicon?.default || eruditAsset('favicon/default.svg');
-
-export function useFavicon() {
-    return useState('favicon', () => defaultFavicon);
-}
+import eruditConfig from '#erudit/config';
+
+export const defaultFavicon =
+    eruditConfig.site?.favicon?.default || eruditAsset('favicon/default.svg');
+
+export function useFavicon() {
+    return useState('favicon', () => defaultFavicon);
+}