Refactor to TypeScript ES modules and add metadata sidebar
This commit is contained in:
@@ -0,0 +1,89 @@
|
||||
/**
|
||||
* Types shared between the server (Preact SSR) and the client (gallery).
|
||||
* Only put a type here if it crosses the server/client boundary - i.e. it
|
||||
* describes data the server serialises into the gallery's init JSON block.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Per-asset EXIF / location metadata shown in the info sidebar. Each field
|
||||
* is optional - the server only includes a field if both the group is
|
||||
* enabled (`ipp.showMetadata.exif.enabled` or `.location.enabled`) and the
|
||||
* per-field flag is true. Strings are plain text (the client uses
|
||||
* `textContent`, not `innerHTML`).
|
||||
*/
|
||||
export interface GalleryExif {
|
||||
dateTimeOriginal?: string // ISO date string; client formats with Intl.DateTimeFormat
|
||||
fileName?: string
|
||||
width?: number
|
||||
height?: number
|
||||
fileSizeInByte?: number // raw bytes; client formats for display
|
||||
make?: string
|
||||
model?: string
|
||||
lensModel?: string
|
||||
exposureTime?: string
|
||||
iso?: number
|
||||
fNumber?: number
|
||||
focalLength?: number
|
||||
city?: string
|
||||
state?: string
|
||||
country?: string
|
||||
latitude?: number
|
||||
longitude?: number
|
||||
}
|
||||
|
||||
export interface GalleryItem {
|
||||
id: string
|
||||
type: 'IMAGE' | 'VIDEO'
|
||||
previewUrl: string
|
||||
thumbnailUrl: string
|
||||
downloadUrl?: string
|
||||
// Pre-stringified JSON describing the video source (used to build a <video>
|
||||
// element for video slides in the PhotoSwipe lightbox)
|
||||
videoData?: string
|
||||
// Plain-text caption shown below the image in the lightbox and at the top
|
||||
// of the info sidebar. Rendered with `textContent` on the client.
|
||||
description?: string
|
||||
downloadFilename: string
|
||||
// Display dimensions after EXIF orientation correction; needed for the
|
||||
// pre-computed justified-rows layout that virtualization depends on.
|
||||
width?: number
|
||||
height?: number
|
||||
// Base64-encoded thumbhash for an optional blur placeholder behind each tile
|
||||
thumbhash?: string
|
||||
// ISO date string from Immich; used to group tiles by month when enabled.
|
||||
fileCreatedAt?: string
|
||||
// Per-field gated EXIF / location metadata for the sidebar (see GalleryExif).
|
||||
exif?: GalleryExif
|
||||
}
|
||||
|
||||
export interface LightboxConfig {
|
||||
showArrows: boolean
|
||||
showDownload: boolean
|
||||
mobileArrows: boolean
|
||||
options?: Record<string, unknown>
|
||||
}
|
||||
|
||||
/**
|
||||
* Metadata-rendering decisions made server-side and forwarded to the client.
|
||||
* Whether to render description in each surface, and whether the sidebar
|
||||
* has any content the operator wants surfaced (when false, the client skips
|
||||
* registering the sidebar + its toolbar toggle entirely).
|
||||
*/
|
||||
export interface MetadataConfig {
|
||||
descriptionInCaption: boolean
|
||||
descriptionInSidebar: boolean
|
||||
sidebarHasContent: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Shape of the JSON init block embedded in `gallery.tsx` and consumed by
|
||||
* `client/init.ts`. The server writes it via `JSON.stringify`; the client
|
||||
* reads it via `readInitParams()`.
|
||||
*/
|
||||
export interface InitParams {
|
||||
items?: GalleryItem[]
|
||||
openItem?: number
|
||||
lightboxConfig?: LightboxConfig
|
||||
metadataConfig?: MetadataConfig
|
||||
groupByDate?: boolean
|
||||
}
|
||||
Reference in New Issue
Block a user