Merge pull request #302 from ldgallery/oz-types-normalization

viewer: types normalization

34 files changed, 274 insertions, 234 deletions

diff --git a/viewer/src/@types/ItemType.ts b/viewer/src/@types/ItemType.ts
index 31a395b..9974d4e 100644
--- a/viewer/src/@types/ItemType.ts
+++ b/viewer/src/@types/ItemType.ts
@@ -1,4 +1,21 @@
-// TODO: Convert all ambiant types related to LdGallery to modules
+/* ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2021  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
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
 
 export enum ItemType {
   OTHER = "other",
diff --git a/viewer/src/@types/gallery.d.ts b/viewer/src/@types/gallery.d.ts
index e9b80e6..d9e7534 100644
--- a/viewer/src/@types/gallery.d.ts
+++ b/viewer/src/@types/gallery.d.ts
@@ -17,98 +17,99 @@
 -- along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
-declare namespace Gallery {
-  type ItemSortStr = "title_asc" | "date_asc" | "date_desc";
+import { ItemType } from "./ItemType";
 
-  interface Config {
-    galleryRoot: string;
-    galleryIndex?: string;
-    initialItemSort?: ItemSortStr;
-    initialTagDisplayLimit?: number;
-  }
+export type ItemSortStr = "title_asc" | "date_asc" | "date_desc";
 
-  interface GalleryProperties {
-    galleryTitle: string;
-    tagCategories: RawTag[];
-  }
-  interface Index {
-    properties: GalleryProperties;
-    tree: Directory;
-  }
+export interface Config {
+  galleryRoot: string;
+  galleryIndex?: string;
+  initialItemSort?: ItemSortStr;
+  initialTagDisplayLimit?: number;
+}
+
+export interface Properties {
+  galleryTitle: string;
+  tagCategories: RawTag[];
+}
+export interface Index {
+  properties: Properties;
+  tree: DirectoryItem;
+}
+
+export interface OtherItem extends Item {
+  properties: OtherProperties;
+}
+export interface PictureItem extends Item {
+  properties: PictureProperties;
+}
+export interface PlainTextItem extends Item {
+  properties: PlainTextProperties;
+}
+export interface PDFItem extends Item {
+  properties: PDFProperties;
+}
+export interface VideoItem extends Item {
+  properties: VideoProperties;
+}
+export interface AudioItem extends Item {
+  properties: AudioProperties;
+}
+export interface DirectoryItem extends Item {
+  properties: DirectoryProperties;
+}
+export interface Item {
+  title: string;
+  datetime: string;
+  description: string;
+  tags: RawTag[];
+  path: string;
+  thumbnail?: Thumbnail;
+  properties:
+    | OtherProperties
+    | PictureProperties
+    | PlainTextProperties
+    | PDFProperties
+    | VideoProperties
+    | AudioProperties
+    | DirectoryProperties;
+}
+export interface Resolution {
+  width: number;
+  height: number;
+}
+export interface OtherProperties {
+  type: ItemType.OTHER;
+  resource: string;
+}
+export interface PictureProperties {
+  type: ItemType.PICTURE;
+  resource: string;
+  resolution: Resolution;
+}
+export interface PlainTextProperties {
+  type: ItemType.PLAINTEXT;
+  resource: string;
+}
+export interface PDFProperties {
+  type: ItemType.PDF;
+  resource: string;
+}
+export interface VideoProperties {
+  type: ItemType.VIDEO;
+  resource: string;
+}
+export interface AudioProperties {
+  type: ItemType.AUDIO;
+  resource: string;
+}
+export interface DirectoryProperties {
+  type: ItemType.DIRECTORY;
+  items: Item[];
+}
 
-  interface Other extends Item {
-    properties: OtherProperties;
-  }
-  interface Picture extends Item {
-    properties: PictureProperties;
-  }
-  interface PlainText extends Item {
-    properties: PlainTextProperties;
-  }
-  interface PDF extends Item {
-    properties: PDFProperties;
-  }
-  interface Video extends Item {
-    properties: VideoProperties;
-  }
-  interface Audio extends Item {
-    properties: AudioProperties;
-  }
-  interface Directory extends Item {
-    properties: DirectoryProperties;
-  }
-  interface Item {
-    title: string;
-    datetime: string;
-    description: string;
-    tags: RawTag[];
-    path: string;
-    thumbnail?: Thumbnail;
-    properties:
-      | OtherProperties
-      | PictureProperties
-      | PlainTextProperties
-      | PDFProperties
-      | VideoProperties
-      | AudioProperties
-      | DirectoryProperties;
-  }
-  interface Resolution {
-    width: number;
+export interface Thumbnail {
+  resource: string;
+  resolution: Resolution;