aboutsummaryrefslogtreecommitdiff
path: root/viewer/src/@types
diff options
context:
space:
mode:
Diffstat (limited to 'viewer/src/@types')
-rw-r--r--viewer/src/@types/ItemType.ts11
-rw-r--r--viewer/src/@types/gallery.d.ts114
-rw-r--r--viewer/src/@types/gallery.ts129
-rw-r--r--viewer/src/@types/itemType.ts (renamed from viewer/src/@types/v-lazy-image.d.ts)13
-rw-r--r--viewer/src/@types/operation.ts (renamed from viewer/src/@types/Operation.ts)8
-rw-r--r--viewer/src/@types/scrollposition.d.ts20
-rw-r--r--viewer/src/@types/splashscreen.ts (renamed from viewer/src/@types/vue-dragscroll.d.ts)9
-rw-r--r--viewer/src/@types/tag.ts (renamed from viewer/src/@types/tag.d.ts)43
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 @@
1// TODO: Convert all ambiant types related to LdGallery to modules
2
3export enum ItemType {
4 OTHER = "other",
5 PICTURE = "picture",
6 PLAINTEXT = "plaintext",
7 PDF = "pdf",
8 VIDEO = "video",
9 AUDIO = "audio",
10 DIRECTORY = "directory",
11}
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 @@
1/* ldgallery - A static generator which turns a collection of tagged
2-- pictures into a searchable web gallery.
3--
4-- Copyright (C) 2019-2020 Guillaume FOUET
5--
6-- This program is free software: you can redistribute it and/or modify
7-- it under the terms of the GNU Affero General Public License as
8-- published by the Free Software Foundation, either version 3 of the
9-- License, or (at your option) any later version.
10--
11-- This program is distributed in the hope that it will be useful,
12-- but WITHOUT ANY WARRANTY; without even the implied warranty of
13-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14-- GNU Affero General Public License for more details.
15--
16-- You should have received a copy of the GNU Affero General Public License
17-- along with this program. If not, see <https://www.gnu.org/licenses/>.
18*/
19
20declare namespace Gallery {
21 type ItemSortStr = "title_asc" | "date_asc" | "date_desc";
22
23 interface Config {
24 galleryRoot: string;
25 galleryIndex?: string;
26 initialItemSort?: ItemSortStr;
27 initialTagDisplayLimit?: number;
28 }
29
30 interface GalleryProperties {
31 galleryTitle: string;
32 tagCategories: RawTag[];
33 }
34 interface Index {
35 properties: GalleryProperties;
36 tree: Directory;
37 }
38
39 interface Other extends Item {
40 properties: OtherProperties;
41 }
42 interface Picture extends Item {
43 properties: PictureProperties;
44 }
45 interface PlainText extends Item {
46 properties: PlainTextProperties;
47 }
48 interface PDF extends Item {
49 properties: PDFProperties;
50 }
51 interface Video extends Item {
52 properties: VideoProperties;
53 }
54 interface Audio extends Item {
55 properties: AudioProperties;
56 }
57 interface Directory extends Item {
58 properties: DirectoryProperties;
59 }
60 interface Item {
61 title: string;
62 datetime: string;
63 description: string;
64 tags: RawTag[];
65 path: string;
66 thumbnail?: Thumbnail;
67 properties:
68 | OtherProperties
69 | PictureProperties
70 | PlainTextProperties
71 | PDFProperties
72 | VideoProperties
73 | AudioProperties
74 | DirectoryProperties;
75 }
76 interface Resolution {
77 width: number;
78 height: number;
79 }
80 interface OtherProperties {
81 type: import("./ItemType").ItemType.OTHER;
82 resource: string;
83 }
84 interface PictureProperties {
85 type: import("./ItemType").ItemType.PICTURE;
86 resource: string;
87 resolution: Resolution;
88 }
89 interface PlainTextProperties {
90 type: import("./ItemType").ItemType.PLAINTEXT;
91 resource: string;
92 }
93 interface PDFProperties {
94 type: import("./ItemType").ItemType.PDF;
95 resource: string;
96 }
97 interface VideoProperties {
98 type: import("./ItemType").ItemType.VIDEO;
99 resource: string;
100 }
101 interface AudioProperties {
102 type: import("./ItemType").ItemType.AUDIO;
103 resource: string;
104 }
105 interface DirectoryProperties {
106 type: import("./ItemType").ItemType.DIRECTORY;
107 items: Item[];
108 }
109 interface Thumbnail {
110 resource: string;
111 resolution: Resolution;
112 }
113 type RawTag = string;
114}
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 @@
1/* ldgallery - A static generator which turns a collection of tagged
2-- pictures into a searchable web gallery.
3--
4-- Copyright (C) 2019-2022 Guillaume FOUET
5--
6-- This program is free software: you can redistribute it and/or modify
7-- it under the terms of the GNU Affero General Public License as
8-- published by the Free Software Foundation, either version 3 of the
9-- License, or (at your option) any later version.
10--
11-- This program is distributed in the hope that it will be useful,
12-- but WITHOUT ANY WARRANTY; without even the implied warranty of
13-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14-- GNU Affero General Public License for more details.
15--
16-- You should have received a copy of the GNU Affero General Public License
17-- along with this program. If not, see <https://www.gnu.org/licenses/>.
18*/
19
20import { ItemType } from './itemType';
21import { SplashScreenConfig } from './splashscreen';
22
23export type ItemSortStr = 'title_asc' | 'date_asc' | 'date_desc';
24
25export interface Config {
26 galleryRoot: string;
27 galleryIndex?: string;
28 initialItemSort?: ItemSortStr;
29 initialTagDisplayLimit?: number;
30 splashScreen?: SplashScreenConfig;
31}
32
33// ---
34
35export interface Resolution {
36 width: number;
37 height: number;
38}
39export interface Thumbnail {
40 resource: string;
41 resolution: Resolution;
42}
43export type RawTag = string;
44
45// ---
46
47export interface Downloadable {
48 resource: string;
49 type: ItemType; // unknown
50}
51export interface OtherProperties extends Downloadable {
52 type: ItemType.OTHER;
53}
54export interface PictureProperties extends Downloadable {
55 type: ItemType.PICTURE;
56 resolution: Resolution;
57}
58export interface PlainTextProperties extends Downloadable {
59 type: ItemType.PLAINTEXT;
60}
61export interface MarkdownProperties extends Downloadable {
62 type: ItemType.MARKDOWN;
63}
64export interface PDFProperties extends Downloadable {
65 type: ItemType.PDF;
66}
67export interface VideoProperties extends Downloadable {
68 type: ItemType.VIDEO;
69}
70export interface AudioProperties extends Downloadable {
71 type: ItemType.AUDIO;
72}
73export interface DirectoryProperties {
74 type: ItemType.DIRECTORY;
75 // eslint-disable-next-line no-use-before-define
76 items: Item[];
77}
78
79// ---
80
81export interface Item {
82 title: string;
83 datetime: string;
84 description: string;
85 tags: RawTag[];
86 path: string;
87 thumbnail?: Thumbnail;
88 properties:
89 | Downloadable
90 | DirectoryProperties;
91}
92export interface DownloadableItem extends Item { // Special unknown item type
93 properties: Downloadable;
94}
95export interface OtherItem extends Item {
96 properties: OtherProperties;
97}
98export interface PictureItem extends Item {
99 properties: PictureProperties;
100}
101export interface PlainTextItem extends Item {
102 properties: PlainTextProperties;
103}
104export interface MarkdownItem extends Item {
105 properties: MarkdownProperties;
106}
107export interface PDFItem extends Item {
108 properties: PDFProperties;
109}
110export interface VideoItem extends Item {