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

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,69 @@
-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';
+
+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/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);
+}

package/app/composables/formatText.ts

@@ -1,86 +1,99 @@
-import eruditConfig from '#erudit/config';
-
-let formatFunction: FormatFunction;
-
-export function useFormatText() {
-    if (!formatFunction) {
-        const language = eruditConfig?.language;
-        formatFunction = createFormatFunction(language);
-    }
-
-    return formatFunction;
-}
-
-type FormatFunction = (text: string) => string;
-
-function createFormatFunction(language?: string): FormatFunction {
-    const formatters: FormatFunction[] = [];
-
-    //
-    // Em Dashes
-    //
-
-    formatters.push((text) => text.replace(/(^| )--($| )/gm, '$1—$2'));
-
-    //
-    // Quotes
-    //
-
-    {
-        const quoteSymbols: [string, string] = (() => {
-            switch (language) {
-                case 'ru':
-                    return ['«', '»'];
-                default:
-                    return ['“', '”'];
-            }
-        })();
-
-        formatters.push((text) => {
-            let open = false;
-            return text.replaceAll(/"/gm, () => {
-                return (open = !open) ? quoteSymbols[0] : quoteSymbols[1];
-            });
-        });
-    }
-
-    //
-    // Ellipsis
-    //
-
-    formatters.push((text) => text.replace(/\.\.\./gm, '…'));
-
-    //
-    // Language specific formatters
-    //
-
-    if (language === 'ru') formatters.push(ruStickyPrepositions);
-
-    //
-    //
-    //
-
-    function formatText(text: string): string {
-        if (!text) return text;
-
-        for (const formatter of formatters) text = formatter(text);
-
-        return text;
-    }
-
-    return formatText;
-}
-
-//
-//
-//
-
-/**
- * Formats prepositions in Russian text so that they are always adjacent to the next word and are not left hanging “in the air” when the line breaks.
- */
-function ruStickyPrepositions(text: string): string {
-    return text.replace(
-        / (в|не|без|для|до|за|из|к|на|над|о|об|от|по|под|при|про|с|у|через|вокруг|около|после|перед|между|внутри|вне|из-за|из-под|ради|сквозь|среди|насчёт|вследствие|благодаря|несмотря|наперекор|вопреки|подле|возле|рядом|навстречу) /gimu,
-        ' $1\xa0',
-    );
-}
+import eruditConfig from '#erudit/config';
+
+export interface FormatState {
+    quoteOpen: boolean;
+}
+
+const defaultFormatState: FormatState = {
+    quoteOpen: false,
+};
+
+export type FormatFunction = (text: string, state?: FormatState) => string;
+export type FormatterFunction = (text: string, state: FormatState) => string;
+
+let formatFunction: FormatFunction;
+
+export function useFormatText() {
+    if (!formatFunction) {
+        const language = eruditConfig?.language;
+        formatFunction = createFormatFunction(language);
+    }
+
+    return formatFunction;
+}
+
+function createFormatFunction(language?: string): FormatFunction {
+    const formatters: FormatterFunction[] = [];
+
+    //
+    // Em Dashes
+    //
+
+    formatters.push((text) => text.replace(/(^| )--($| )/gm, '$1—$2'));
+
+    //
+    // Quotes
+    //
+
+    {
+        const quoteSymbols: [string, string] = (() => {
+            switch (language) {
+                case 'ru':
+                    return ['«', '»'];
+                default:
+                    return ['“', '”'];
+            }
+        })();
+
+        formatters.push((text, state) => {
+            return text.replaceAll(/"/gm, () => {
+                return (state.quoteOpen = !state.quoteOpen)
+                    ? quoteSymbols[0]
+                    : quoteSymbols[1];
+            });
+        });
+    }
+
+    //
+    // Ellipsis
+    //
+
+    formatters.push((text) => text.replace(/\.\.\./gm, '…'));
+
+    //
+    // Language specific formatters
+    //
+
+    if (language === 'ru') formatters.push(ruStickyPrepositions);
+
+    //
+    //
+    //
+
+    function formatText(
+        text: string,
+        state: FormatState = defaultFormatState,
+    ): string {
+        if (!text) return text;
+
+        for (const formatter of formatters) text = formatter(text, state);
+
+        return text;
+    }
+
+    return formatText;
+}
+
+//
+//
+//
+
+/**
+ * Formats prepositions in Russian text so that they are always adjacent to the next word and are not left hanging “in the air” when the line breaks.
+ */
+function ruStickyPrepositions(text: string): string {
+    return text.replace(
+        / (в|не|без|для|до|за|из|к|на|над|о|об|от|по|под|при|про|с|у|через|вокруг|около|после|перед|между|внутри|вне|из-за|из-под|ради|сквозь|среди|насчёт|вследствие|благодаря|несмотря|наперекор|вопреки|подле|возле|рядом|навстречу) /gimu,
+        ' $1\xa0',
+    );
+}

package/app/composables/head.ts

@@ -0,0 +1,24 @@
+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,60 +1,62 @@
-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,
-    };
-}
+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,
+    };
+}