erudit 4.0.0-dev.4 → 4.0.0-dev.5

package/app/composables/appElements.ts

@@ -4,37 +4,37 @@ import { appElements as _appElements } from '#erudit/prose/app';
 export const appElements: Record<string, AppElement> = { ..._appElements };
 
 export async function initAppElements() {
-    for (const [name, element] of Object.entries(appElements)) {
-        const languageCode = ERUDIT.config.project.language.current;
-        if (!element.languages[languageCode]) {
-            throw createError({
-                statusCode: 500,
-                statusMessage: `App element "${name}" does not support the current project language "${languageCode}"!`,
-            });
-        }
+  for (const [name, element] of Object.entries(appElements)) {
+    const languageCode = ERUDIT.config.language.current;
+    if (!element.languages[languageCode]) {
+      throw createError({
+        statusCode: 500,
+        statusMessage: `App element "${name}" does not support the current project language "${languageCode}"!`,
+      });
     }
+  }
 }
 
 export async function getElementIcon(elementName: string) {
-    const appElement = getAppElement(elementName);
-    return await appElement.icon();
+  const appElement = getAppElement(elementName);
+  return await appElement.icon();
 }
 
 export async function getElementPhrase(elementName: string) {
-    const appElement = getAppElement(elementName);
-    const languageCode = ERUDIT.config.project.language.current;
-    return await appElement.languages[languageCode]!();
+  const appElement = getAppElement(elementName);
+  const languageCode = ERUDIT.config.language.current;
+  return await appElement.languages[languageCode]!();
 }
 
 function getAppElement(elementName: string) {
-    const appElement = appElements[elementName];
+  const appElement = appElements[elementName];
 
-    if (!appElement) {
-        throw createError({
-            statusCode: 500,
-            statusMessage: `App element "${elementName}" not found! Make sure it is installed and configured correctly!`,
-        });
-    }
+  if (!appElement) {
+    throw createError({
+      statusCode: 500,
+      statusMessage: `App element "${elementName}" not found! Make sure it is installed and configured correctly!`,
+    });
+  }
 
-    return appElement;
+  return appElement;
 }

package/app/composables/aside.ts

@@ -1,28 +1,28 @@
 export enum AsideType {
-    Major = 'major',
-    Minor = 'minor',
+  Major = 'major',
+  Minor = 'minor',
 }
 
 export interface AsideState {
-    opened: AsideType | undefined;
-    scrolledUp: boolean;
+  opened: AsideType | undefined;
+  scrolledUp: boolean;
 }
 
 export const asideTypeSymbol = Symbol() as InjectionKey<AsideType>;
 
 export const useAsideState = () => {
-    return useState<AsideState>('aside-state', () => ({
-        opened: undefined,
-        scrolledUp: true,
-    }));
+  return useState<AsideState>('aside-state', () => ({
+    opened: undefined,
+    scrolledUp: true,
+  }));
 };
 
 export const useCanShowAsideSwitches = () => {
-    const asideState = useAsideState();
-    const { previewState } = usePreview();
-    return computed(() => {
-        const noOpenedAsides = !asideState.value.opened;
-        const scrolledUp = asideState.value.scrolledUp;
-        return noOpenedAsides && scrolledUp && !previewState.value.opened;
-    });
+  const asideState = useAsideState();
+  const { previewState } = usePreview();
+  return computed(() => {
+    const noOpenedAsides = !asideState.value.opened;
+    const scrolledUp = asideState.value.scrolledUp;
+    return noOpenedAsides && scrolledUp && !previewState.value.opened;
+  });
 };

package/app/composables/asideMajorPane.ts

@@ -2,68 +2,68 @@ import { isTopicPart } from '@erudit-js/core/content/topic';
 import { isContentType } from '@erudit-js/core/content/type';
 
 export enum AsideMajorPane {
-    GlobalNav = 'global-nav',
-    BookNav = 'book-nav',
-    Pages = 'pages',
-    Search = 'search',
-    Settings = 'settings',
-    Languages = 'languages',
+  GlobalNav = 'global-nav',
+  BookNav = 'book-nav',
+  Pages = 'pages',
+  Search = 'search',
+  Settings = 'settings',
+  Languages = 'languages',
 }
 
 export const asideMajorPanes = Object.values(AsideMajorPane);
 
 export const useAsideMajorPane = () => {
-    return useState<AsideMajorPane>('aside-major-pane');
+  return useState<AsideMajorPane>('aside-major-pane');
 };
 
 export const initAsideMajorPaneWatcher = () => {
-    const asideMajorPane = useAsideMajorPane();
-    const routePath = useRoutePath();
-    const { shortBookId } = useContentId();
+  const asideMajorPane = useAsideMajorPane();
+  const routePath = useRoutePath();
+  const { shortBookId } = useContentId();
 
+  asideMajorPane.value = getActivePane(
+    asideMajorPane.value,
+    routePath.value,
+    shortBookId.value,
+  );
+
+  watch([routePath, shortBookId], () => {
     asideMajorPane.value = getActivePane(
-        asideMajorPane.value,
-        routePath.value,
-        shortBookId.value,
+      asideMajorPane.value,
+      routePath.value,
+      shortBookId.value,
     );
-
-    watch([routePath, shortBookId], () => {
-        asideMajorPane.value = getActivePane(
-            asideMajorPane.value,
-            routePath.value,
-            shortBookId.value,
-        );
-    });
+  });
 };
 
 function getActivePane(
-    currentPane: AsideMajorPane,
-    path: string,
-    bookId: string | undefined,
+  currentPane: AsideMajorPane,
+  path: string,
+  bookId: string | undefined,
 ) {
-    if (currentPane === AsideMajorPane.Search) {
-        // The user might be clicking on search result so keep him in search pane!
-        return AsideMajorPane.Search;
-    }
+  if (currentPane === AsideMajorPane.Search) {
+    // The user might be clicking on search result so keep him in search pane!
+    return AsideMajorPane.Search;
+  }
 
-    if (bookId) {
-        return AsideMajorPane.BookNav;
-    }
+  if (bookId) {
+    return AsideMajorPane.BookNav;
+  }
 
-    if (path === PAGES.contributors) {
-        return AsideMajorPane.Pages;
-    }
+  if (path === PAGES.contributors) {
+    return AsideMajorPane.Pages;
+  }
 
-    if (path.startsWith(PAGES.contributor())) {
-        return AsideMajorPane.Pages;
-    }
+  if (path.startsWith(PAGES.contributor())) {
+    return AsideMajorPane.Pages;
+  }
 
-    if (path === PAGES.sponsors) {
-        return AsideMajorPane.Pages;
-    }
+  if (path === PAGES.sponsors) {
+    return AsideMajorPane.Pages;
+  }
 
-    // Fallback to global nav
-    return AsideMajorPane.GlobalNav;
+  // Fallback to global nav
+  return AsideMajorPane.GlobalNav;
 }
 
 //
@@ -73,59 +73,59 @@ function getActivePane(
 export let globalContentNav: FrontGlobalContentNav;
 
 export async function initGlobalContentNav() {
-    const nuxtApp = useNuxtApp();
-    const payloadKey = 'global-content-nav';
-    const payloadValue: FrontGlobalContentNav =
-        (nuxtApp.static.data[payloadKey] ||=
-        nuxtApp.payload.data[payloadKey] ||=
-            await $fetch('/api/aside/major/frontNav/global', {
-                responseType: 'json',
-            }));
-
-    globalContentNav = payloadValue;
+  const nuxtApp = useNuxtApp();
+  const payloadKey = 'global-content-nav';
+  const payloadValue: FrontGlobalContentNav =
+    (nuxtApp.static.data[payloadKey] ||=
+    nuxtApp.payload.data[payloadKey] ||=
+      await $fetch('/api/aside/major/frontNav/global', {
+        responseType: 'json',
+      }));
+
+  globalContentNav = payloadValue;
 }
 
 export function useContentId() {
-    const routePath = useRoutePath();
+  const routePath = useRoutePath();
 
-    const shortContentId = computed(() => {
-        const path = routePath.value;
+  const shortContentId = computed(() => {
+    const path = routePath.value;
 
-        const parts = path.split('/');
-        parts.pop(); // Remove trailing slash part
-        parts.shift(); // Remove leading slash part
+    const parts = path.split('/');
+    parts.pop(); // Remove trailing slash part
+    parts.shift(); // Remove leading slash part
 
-        const type = parts.shift();
-        if (isContentType(type) || isTopicPart(type)) {
-            return parts.join('/');
-        }
+    const type = parts.shift();
+    if (isContentType(type) || isTopicPart(type)) {
+      return parts.join('/');
+    }
 
-        return undefined;
-    });
+    return undefined;
+  });
 
-    const shortBookId = computed(() => {
-        const shortId = shortContentId.value;
+  const shortBookId = computed(() => {
+    const shortId = shortContentId.value;
 
-        if (!shortId) {
-            return undefined;
-        }
+    if (!shortId) {
+      return undefined;
+    }
 
-        let longestMatch = '';
-        for (const bookShortId of globalContentNav.bookShortIds) {
-            if (shortId.startsWith(bookShortId)) {
-                if (bookShortId.length > longestMatch.length) {
-                    longestMatch = bookShortId;
-                }
-            }
+    let longestMatch = '';
+    for (const bookShortId of globalContentNav.bookShortIds) {
+      if (shortId.startsWith(bookShortId)) {
+        if (bookShortId.length > longestMatch.length) {
+          longestMatch = bookShortId;
         }
+      }
+    }
 
-        return longestMatch || undefined;
-    });
+    return longestMatch || undefined;
+  });
 
-    return {
-        shortContentId,
-        shortBookId,
-    };
+  return {
+    shortContentId,
+    shortBookId,
+  };
 }
 
 //

package/app/composables/asideMinor.ts

@@ -1,109 +1,109 @@
-import type {
-    ContentContribution,
-    ContributorContribution,
-} from '@erudit-js/core/content/contributions';
-import type { TopicPart } from '@erudit-js/core/content/topic';
-import type { ContentType } from '@erudit-js/core/content/type';
-import type { ResolvedTocItem } from '@erudit-js/prose';
-
-export interface AsideMinorStateNews {
-    type: 'news';
-}
-
-export interface AsideMinorContributor {
-    type: 'contributor';
-    contributions?: ContributorContribution[];
-}
-
-export interface AsideMinorContentContributions {
-    type: 'content-contributions';
-    contentRelativePath: string;
-    contentType: ContentType;
-    topicPart?: TopicPart;
-    contributions?: ContentContribution[];
-}
-
-export interface AsideMinorContentPage {
-    type: 'content-page';
-    contentRelativePath: string;
-    toc?: ResolvedTocItem[];
-    contributions?: ContentContribution[];
-}
-
-export interface AsideMinorContentTopic {
-    type: 'content-topic';
-    topicPart: TopicPart;
-    contentRelativePath: string;
-    shortContentId: string;
-    parts: TopicPart[];
-    toc?: ResolvedTocItem[];
-    contributions?: ContentContribution[];
-}
-
-export type AsideMinorState =
-    | AsideMinorStateNews
-    | AsideMinorContributor
-    | AsideMinorContentContributions
-    | AsideMinorContentPage
-    | AsideMinorContentTopic;
-
-export const useAsideMinor = () => {
-    const asideMinor = useState<AsideMinorState | undefined>('aside-minor');
-
-    return {
-        asideMinorState: asideMinor,
-        showNewsAside() {
-            asideMinor.value = { type: 'news' };
-        },
-        showContributorAside(contributions?: ContributorContribution[]) {
-            asideMinor.value = {
-                type: 'contributor',
-                contributions,
-            };
-        },
-        showContentContributionsAside(
-            contentRelativePath: string,
-            contentType: ContentType,
-            topicPart?: TopicPart,
-            contributions?: ContentContribution[],
-        ) {
-            asideMinor.value = {
-                type: 'content-contributions',
-                contentRelativePath,
-                contentType,
-                topicPart,
-                contributions,
-            };
-        },
-        showContentPageAside(
-            contentRelativePath: string,
-            toc?: ResolvedTocItem[],
-            contributions?: ContentContribution[],
-        ) {
-            asideMinor.value = {
-                type: 'content-page',
-                contentRelativePath,
-                toc,
-                contributions,
-            };
-        },
-        showContentTopicAside(args: {
-            part: TopicPart;
-            parts: TopicPart[];
-            shortContentId: string;
-            contentRelativePath: string;
-            toc?: ResolvedTocItem[];
-            contributions?: ContentContribution[];
-        }) {
-            asideMinor.value = {
-                type: 'content-topic',
-                topicPart: args.part,
-                contentRelativePath: args.contentRelativePath,
-                toc: args.toc,
-                contributions: args.contributions,
-                shortContentId: args.shortContentId,
-                parts: args.parts,
-            };
-        },
-    };
-};
+import type {
+  ContentContribution,
+  ContributorContribution,
+} from '@erudit-js/core/content/contributions';
+import type { TopicPart } from '@erudit-js/core/content/topic';
+import type { ContentType } from '@erudit-js/core/content/type';
+import type { ResolvedTocItem } from '@erudit-js/prose';
+
+export interface AsideMinorStateNews {
+  type: 'news';
+}
+
+export interface AsideMinorContributor {
+  type: 'contributor';
+  contributions?: ContributorContribution[];
+}
+
+export interface AsideMinorContentContributions {
+  type: 'content-contributions';
+  contentRelativePath: string;
+  contentType: ContentType;
+  topicPart?: TopicPart;
+  contributions?: ContentContribution[];
+}
+
+export interface AsideMinorContentPage {
+  type: 'content-page';
+  contentRelativePath: string;
+  toc?: ResolvedTocItem[];
+  contributions?: ContentContribution[];
+}
+
+export interface AsideMinorContentTopic {
+  type: 'content-topic';
+  topicPart: TopicPart;
+  contentRelativePath: string;
+  shortContentId: string;
+  parts: TopicPart[];
+  toc?: ResolvedTocItem[];
+  contributions?: ContentContribution[];
+}
+
+export type AsideMinorState =
+  | AsideMinorStateNews
+  | AsideMinorContributor
+  | AsideMinorContentContributions
+  | AsideMinorContentPage
+  | AsideMinorContentTopic;
+
+export const useAsideMinor = () => {
+  const asideMinor = useState<AsideMinorState | undefined>('aside-minor');
+
+  return {
+    asideMinorState: asideMinor,
+    showNewsAside() {
+      asideMinor.value = { type: 'news' };
+    },
+    showContributorAside(contributions?: ContributorContribution[]) {
+      asideMinor.value = {
+        type: 'contributor',
+        contributions,
+      };
+    },
+    showContentContributionsAside(
+      contentRelativePath: string,
+      contentType: ContentType,
+      topicPart?: TopicPart,
+      contributions?: ContentContribution[],
+    ) {
+      asideMinor.value = {
+        type: 'content-contributions',
+        contentRelativePath,
+        contentType,
+        topicPart,
+        contributions,
+      };
+    },
+    showContentPageAside(
+      contentRelativePath: string,
+      toc?: ResolvedTocItem[],
+      contributions?: ContentContribution[],
+    ) {
+      asideMinor.value = {
+        type: 'content-page',
+        contentRelativePath,
+        toc,
+        contributions,
+      };
+    },
+    showContentTopicAside(args: {
+      part: TopicPart;
+      parts: TopicPart[];
+      shortContentId: string;
+      contentRelativePath: string;
+      toc?: ResolvedTocItem[];
+      contributions?: ContentContribution[];
+    }) {
+      asideMinor.value = {
+        type: 'content-topic',
+        topicPart: args.part,
+        contentRelativePath: args.contentRelativePath,
+        toc: args.toc,
+        contributions: args.contributions,
+        shortContentId: args.shortContentId,
+        parts: args.parts,
+      };
+    },
+  };
+};

package/app/composables/contentNav.ts

@@ -1,7 +1,7 @@
-const contentNavGlobalKey = 'contentNav-global';
-
-export const contentNavSymbol = Symbol() as InjectionKey<{
-    shortContentId: ComputedRef<string | undefined>;
-    shortBookId: ComputedRef<string | undefined>;
-    showBookNav: Ref<boolean>;
-}>;
+const contentNavGlobalKey = 'contentNav-global';
+
+export const contentNavSymbol = Symbol() as InjectionKey<{
+  shortContentId: ComputedRef<string | undefined>;
+  shortBookId: ComputedRef<string | undefined>;
+  showBookNav: Ref<boolean>;
+}>;