Merge branch 'develop': release v2.1v2.1

GitHub: related to #315

1 files changed, 43 insertions, 45 deletions

diff --git a/viewer/src/services/navigation.ts b/viewer/src/services/navigation.ts
index 5b0716d..b2e807b 100644
--- a/viewer/src/services/navigation.ts
+++ b/viewer/src/services/navigation.ts
@@ -1,7 +1,7 @@
 /* ldgallery - A static generator which turns a collection of tagged
 --             pictures into a searchable web gallery.
 --
--- Copyright (C) 2019-2020  Guillaume FOUET
+-- Copyright (C) 2019-2022  Guillaume FOUET
 --
 -- This program is free software: you can redistribute it and/or modify
 -- it under the terms of the GNU Affero General Public License as
@@ -17,25 +17,31 @@
 -- along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
-import { ItemType } from "@/@types/ItemType";
+import { DirectoryItem, DownloadableItem, Item } from '@/@types/gallery';
+import { ItemType } from '@/@types/itemType';
+import { faFile, faFileAlt, faFileAudio, faFilePdf, faFileVideo, faFolder, faHome, faImage, IconDefinition } from '@fortawesome/free-solid-svg-icons';
+import { isDirectory } from './itemGuards';
 
-export default class Navigation {
-  static readonly ICON_BY_TYPE: Record<ItemType, string> = {
-    directory: "folder",
-    picture: "image",
-    plaintext: "file-alt",
-    pdf: "file-pdf",
-    video: "file-video",
-    audio: "file-audio",
-    other: "file",
-  };
+const ICON_BY_TYPE: Record<ItemType, IconDefinition> = {
+  directory: faFolder,
+  picture: faImage,
+  plaintext: faFileAlt,
+  markdown: faFileAlt,
+  pdf: faFilePdf,
+  video: faFileVideo,
+  audio: faFileAudio,
+  other: faFile,
+};
+
+// ---
 
+export const useNavigation = () => {
   // Searches for an item by path from a root item (navigation)
-  public static searchCurrentItemPath(root: Gallery.Item, path: string): Gallery.Item[] {
+  function searchCurrentItemPath(root: Item, path: string): Item[] {
     if (path === root.path) return [root];
-    if (root.properties.type === ItemType.DIRECTORY && path.startsWith(root.path)) {
+    if (isDirectory(root) && path.startsWith(root.path)) {
       const itemChain = root.properties.items
-        .map(item => this.searchCurrentItemPath(item, path))
+        .map(item => searchCurrentItemPath(item, path))
         .find(itemChain => itemChain.length > 0);
       if (itemChain) return [root, ...itemChain];
     }
@@ -43,47 +49,39 @@ export default class Navigation {
   }
 
   // Normalize a string to lowercase, no-accents
-  public static normalize(value: string) {
+  function normalize(value: string) {
     return value
-      .normalize("NFD")
-      .replace(/[\u0300-\u036f]/g, "")
+      .normalize('NFD')
+      .replace(/[\u0300-\u036f]/g, '')
       .toLowerCase();
   }
 
-  // Checks if the type of an item matches
-  public static checkType(item: Gallery.Item | null, type: ItemType | null): boolean {
-    return (item?.properties.type ?? null) === type;
-  }
-
-  public static getLastDirectory(itemPath: Gallery.Item[]): Gallery.Directory {
+  function getLastDirectory(itemPath: Item[]): DirectoryItem {
     for (let idx = itemPath.length - 1; idx >= 0; idx--) {
       const item = itemPath[idx];
-      if (Navigation.checkType(item, ItemType.DIRECTORY)) return item as Gallery.Directory;
+      if (isDirectory(item)) return item;
     }
-    throw new Error("No directory found");
-  }
-
-  // Sort a list of items, moving the directories to the beginning of the list
-  public static directoriesFirst(items: Gallery.Item[]) {
-    return [
-      ...items
-        .filter(child => Navigation.checkType(child, ItemType.DIRECTORY))
-        .sort((a, b) => a.title.localeCompare(b.title)),
-
-      ...items.filter(child => !Navigation.checkType(child, ItemType.DIRECTORY)),
-    ];
+    throw new Error('No directory found');
   }
 
   // Get the icon for an item
-  public static getIcon(item: Gallery.Item): string {
-    if (item.path.length <= 1) return "home";
-    return Navigation.ICON_BY_TYPE[item.properties.type];
+  function getIcon(item: Item): IconDefinition {
+    if (item.path.length <= 1) return faHome;
+    return ICON_BY_TYPE[item.properties.type];
   }
 
   // Get the file name of an item, without its cache timestamp
-  public static getFileName(item: Gallery.Item): string {
-    if (item.properties.type === ItemType.DIRECTORY) return item.title;
-    const timeStamped = item.properties.resource.split("/").pop() ?? "";
-    return timeStamped.split("?")[0];
+  function getFileName(item: Item): string {
+    if (isDirectory(item)) return item.title;
+    const timeStamped = (item as DownloadableItem).properties.resource.split('/').pop() ?? '';
+    return timeStamped.split('?')[0];
   }
-}
+
+  return {
+    searchCurrentItemPath,
+    normalize,
+    getLastDirectory,
+    getIcon,
+    getFileName,
+  };
+};