blob: 6960de2f53939715ea645a0e7a8871be6a2fe65b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/* 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 EPUBProperties extends Downloadable {
type: ItemType.EPUB;
}
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;
}
export interface MarkdownItem extends Item {
properties: MarkdownProperties;
}
export interface PDFItem extends Item {
properties: PDFProperties;
}
export interface EPUBItem extends Item {
properties: EPUBProperties;
}
export interface VideoItem extends Item {
properties: VideoProperties;
}
export interface AudioItem extends Item {
properties: AudioProperties;
}
export interface DirectoryItem extends Item {
properties: DirectoryProperties;
}
// ---
export interface IndexProperties {
galleryTitle: string;
tagCategories: RawTag[];
}
export interface Index {
properties: IndexProperties;
tree: DirectoryItem;
}
|