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

GitHub: related to #315

8 files changed, 173 insertions, 174 deletions

diff --git a/viewer/src/@types/ItemType.ts b/viewer/src/@types/ItemType.ts
deleted file mode 100644
index 31a395b..0000000
--- a/viewer/src/@types/ItemType.ts
+++ /dev/null
@@ -1,11 +0,0 @@
-// TODO: Convert all ambiant types related to LdGallery to modules
-
-export enum ItemType {
-  OTHER = "other",
-  PICTURE = "picture",
-  PLAINTEXT = "plaintext",
-  PDF = "pdf",
-  VIDEO = "video",
-  AUDIO = "audio",
-  DIRECTORY = "directory",
-}
diff --git a/viewer/src/@types/gallery.d.ts b/viewer/src/@types/gallery.d.ts
deleted file mode 100644
index e9b80e6..0000000
--- a/viewer/src/@types/gallery.d.ts
+++ /dev/null
@@ -1,114 +0,0 @@
-/* ldgallery - A static generator which turns a collection of tagged
---             pictures into a searchable web gallery.
---
--- Copyright (C) 2019-2020  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/>.
-*/
-
-declare namespace Gallery {
-  type ItemSortStr = "title_asc" | "date_asc" | "date_desc";
-
-  interface Config {
-    galleryRoot: string;
-    galleryIndex?: string;
-    initialItemSort?: ItemSortStr;
-    initialTagDisplayLimit?: number;
-  }
-
-  interface GalleryProperties {
-    galleryTitle: string;
-    tagCategories: RawTag[];
-  }
-  interface Index {
-    properties: GalleryProperties;
-    tree: Directory;
-  }
-
-  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;
-    height: number;
-  }
-  interface OtherProperties {
-    type: import("./ItemType").ItemType.OTHER;
-    resource: string;
-  }
-  interface PictureProperties {
-    type: import("./ItemType").ItemType.PICTURE;
-    resource: string;
-    resolution: Resolution;
-  }
-  interface PlainTextProperties {
-    type: import("./ItemType").ItemType.PLAINTEXT;
-    resource: string;
-  }
-  interface PDFProperties {
-    type: import("./ItemType").ItemType.PDF;
-    resource: string;
-  }
-  interface VideoProperties {
-    type: import("./ItemType").ItemType.VIDEO;
-    resource: string;
-  }
-  interface AudioProperties {
-    type: import("./ItemType").ItemType.AUDIO;
-    resource: string;
-  }
-  interface DirectoryProperties {
-    type: import("./ItemType").ItemType.DIRECTORY;
-    items: Item[];
-  }
-  interface Thumbnail {
-    resource: string;
-    resolution: Resolution;
-  }
-  type RawTag = string;
-}
diff --git a/viewer/src/@types/gallery.ts b/viewer/src/@types/gallery.ts
new file mode 100644
index 0000000..8c0f177
--- /dev/null
+++ b/viewer/src/@types/gallery.ts
@@ -0,0 +1,129 @@
+/* ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- 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
+-- 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/>.
+*/
+
+import { ItemType } from './itemType';
+import { SplashScreenConfig } from './splashscreen';
+
+export type ItemSortStr = 'title_asc' | 'date_asc' | 'date_desc';
+
+export interface Config {
+  galleryRoot: string;
+  galleryIndex?: string;
+  initialItemSort?: ItemSortStr;
+  initialTagDisplayLimit?: number;
+  splashScreen?: SplashScreenConfig;
+}
+
+// ---
+
+export interface Resolution {
+  width: number;
+  height: number;
+}
+export interface Thumbnail {
+  resource: string;
+  resolution: Resolution;
+}
+export type RawTag = string;
+
+// ---
+
+export interface Downloadable {
+  resource: string;
+  type: ItemType; // unknown
+}
+export interface OtherProperties extends Downloadable {
+  type: ItemType.OTHER;
+}
+export interface PictureProperties extends Downloadable {
+  type: ItemType.PICTURE;
+  resolution: Resolution;
+}
+export interface PlainTextProperties extends Downloadable {
+  type: ItemType.PLAINTEXT;
+}
+export interface MarkdownProperties extends Downloadable {
+  type: ItemType.MARKDOWN;
+}
+export interface PDFProperties extends Downloadable {
+  type: ItemType.PDF;
+}
+export interface VideoProperties extends Downloadable {
+  type: ItemType.VIDEO;
+}
+export interface AudioProperties extends Downloadable {
+  type: ItemType.AUDIO;
+}
+export interface DirectoryProperties {
+  type: ItemType.DIRECTORY;
+  // eslint-disable-next-line no-use-before-define
+  items: Item[];
+}
+
+// ---
+
+export interface Item {
+  title: string;
+  datetime: string;
+  description: string;
+  tags: RawTag[];
+  path: string;
+  thumbnail?: Thumbnail;
+  properties:
+    | Downloadable
+    | DirectoryProperties;
+}
+export interface DownloadableItem extends Item { // Special unknown item type
+  properties: Downloadable;
+}
+export interface OtherItem extends Item {
+  properties: OtherProperties;
+}
+export interface PictureItem extends Item {
+  properties: PictureProperties;
+}
+export interface PlainTextItem extends Item {
+  properties: PlainTextProperties;
+}