From 9165cc1efcf7791f78b61b2c51a9de651b1b09aa Mon Sep 17 00:00:00 2001
From: Zero~Informatique
Date: Fri, 2 Jul 2021 22:53:16 +0200
Subject: viewer: types normalization - gallery.d.ts

GitHub: closes #301
---
 .../src/components/item_handlers/LdAudioViewer.vue |   5 +-
 .../src/components/item_handlers/LdDirectory.vue   |  42 -------
 .../components/item_handlers/LdDirectoryViewer.vue |  43 +++++++
 viewer/src/components/item_handlers/LdDownload.vue |  57 ---------
 .../components/item_handlers/LdDownloadViewer.vue  |  58 ++++++++++
 .../src/components/item_handlers/LdPdfViewer.vue   |   3 +-
 viewer/src/components/item_handlers/LdPicture.vue  | 127 --------------------
 .../components/item_handlers/LdPictureViewer.vue   | 128 +++++++++++++++++++++
 .../components/item_handlers/LdPlainTextViewer.vue |   3 +-
 .../src/components/item_handlers/LdVideoViewer.vue |   3 +-
 10 files changed, 238 insertions(+), 231 deletions(-)
 delete mode 100644 viewer/src/components/item_handlers/LdDirectory.vue
 create mode 100644 viewer/src/components/item_handlers/LdDirectoryViewer.vue
 delete mode 100644 viewer/src/components/item_handlers/LdDownload.vue
 create mode 100644 viewer/src/components/item_handlers/LdDownloadViewer.vue
 delete mode 100644 viewer/src/components/item_handlers/LdPicture.vue
 create mode 100644 viewer/src/components/item_handlers/LdPictureViewer.vue

(limited to 'viewer/src/components/item_handlers')

diff --git a/viewer/src/components/item_handlers/LdAudioViewer.vue b/viewer/src/components/item_handlers/LdAudioViewer.vue
index 2e0f8dc..559b10a 100644
--- a/viewer/src/components/item_handlers/LdAudioViewer.vue
+++ b/viewer/src/components/item_handlers/LdAudioViewer.vue
@@ -28,12 +28,13 @@
 </template>
 
 <script lang="ts">
-import { Component, Prop, Vue } from "vue-property-decorator";
+import { AudioItem } from "@/@types/gallery";
 import Navigation from "@/services/navigation";
+import { Component, Prop, Vue } from "vue-property-decorator";
 
 @Component
 export default class LdAudioViewer extends Vue {
-  @Prop({ required: true }) readonly item!: Gallery.Audio;
+  @Prop({ required: true }) readonly item!: AudioItem;
 
   get itemResourceUrl(): string {
     return this.$galleryStore.resourceRoot + this.item.properties.resource;
diff --git a/viewer/src/components/item_handlers/LdDirectory.vue b/viewer/src/components/item_handlers/LdDirectory.vue
deleted file mode 100644
index eec8011..0000000
--- a/viewer/src/components/item_handlers/LdDirectory.vue
+++ /dev/null
@@ -1,42 +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/>.
--->
-
-<template>
-  <ld-gallery :items="orderedItems" :noresult="$t('directory.no-results')" />
-</template>
-
-<script lang="ts">
-import { Component, Vue, Prop } from "vue-property-decorator";
-import Navigation from "@/services/navigation";
-
-@Component
-export default class LdDirectory extends Vue {
-  @Prop({ required: true }) readonly item!: Gallery.Directory;
-
-  mounted() {
-    this.$uiStore.toggleFullscreen(false);
-  }
-
-  get orderedItems() {
-    return Navigation.directoriesFirst(this.item.properties.items);
-  }
-}
-</script>
-
-<style lang="scss"></style>
diff --git a/viewer/src/components/item_handlers/LdDirectoryViewer.vue b/viewer/src/components/item_handlers/LdDirectoryViewer.vue
new file mode 100644
index 0000000..7440f54
--- /dev/null
+++ b/viewer/src/components/item_handlers/LdDirectoryViewer.vue
@@ -0,0 +1,43 @@
+<!-- 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/>.
+-->
+
+<template>
+  <ld-gallery :items="orderedItems" :noresult="$t('directory.no-results')" />
+</template>
+
+<script lang="ts">
+import { DirectoryItem } from "@/@types/gallery";
+import Navigation from "@/services/navigation";
+import { Component, Prop, Vue } from "vue-property-decorator";
+
+@Component
+export default class LdDirectoryViewer extends Vue {
+  @Prop({ required: true }) readonly item!: DirectoryItem;
+
+  mounted() {
+    this.$uiStore.toggleFullscreen(false);
+  }
+
+  get orderedItems() {
+    return Navigation.directoriesFirst(this.item.properties.items);
+  }
+}
+</script>
+
+<style lang="scss"></style>
diff --git a/viewer/src/components/item_handlers/LdDownload.vue b/viewer/src/components/item_handlers/LdDownload.vue
deleted file mode 100644
index 7b09dab..0000000
--- a/viewer/src/components/item_handlers/LdDownload.vue
+++ /dev/null
@@ -1,57 +0,0 @@
-<!--
--- ldgallery - A static generator which turns a collection of tagged
---             pictures into a searchable web gallery.
---
--- Copyright (C) 2020  Pacien TRAN-GIRARD
---
--- 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/>.
--->
-
-<template>
-  <div class="container-vh-centering">
-    <a :class="$style.content" :download="itemFileName" :href="itemDownloadUrl">
-      <!-- TODO: show thumbnail instead of this generic file download icon? -->
-      <fa-icon :class="$style.icon" icon="file-download" size="6x" />
-      <div>{{ $t("download.download-file-fmt", [itemFileName]) }}</div>
-    </a>
-  </div>
-</template>
-
-<script lang="ts">
-import { Component, Prop, Vue } from "vue-property-decorator";
-import Navigation from "@/services/navigation";
-
-@Component
-export default class LdDownload extends Vue {
-  @Prop({ required: true }) readonly item!: Gallery.Other;
-
-  get itemFileName(): string {
-    return Navigation.getFileName(this.item);
-  }
-
-  get itemDownloadUrl(): string {
-    return this.$galleryStore.resourceRoot + this.item.properties.resource;
-  }
-}
-</script>
-
-<style lang="scss" module>
-.content {
-  text-align: center;
-}
-
-.icon {
-  margin-bottom: 0.15em;
-}
-</style>
diff --git a/viewer/src/components/item_handlers/LdDownloadViewer.vue b/viewer/src/components/item_handlers/LdDownloadViewer.vue
new file mode 100644
index 0000000..60c7c49
--- /dev/null
+++ b/viewer/src/components/item_handlers/LdDownloadViewer.vue
@@ -0,0 +1,58 @@
+<!--
+-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2020  Pacien TRAN-GIRARD
+--
+-- 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/>.
+-->
+
+<template>
+  <div class="container-vh-centering">
+    <a :class="$style.content" :download="itemFileName" :href="itemDownloadUrl">
+      <!-- TODO: show thumbnail instead of this generic file download icon? -->
+      <fa-icon :class="$style.icon" icon="file-download" size="6x" />
+      <div>{{ $t("download.download-file-fmt", [itemFileName]) }}</div>
+    </a>
+  </div>
+</template>
+
+<script lang="ts">
+import { OtherItem } from "@/@types/gallery";
+import Navigation from "@/services/navigation";
+import { Component, Prop, Vue } from "vue-property-decorator";
+
+@Component
+export default class LdDownloadViewer extends Vue {
+  @Prop({ required: true }) readonly item!: OtherItem;
+
+  get itemFileName(): string {
+    return Navigation.getFileName(this.item);
+  }
+
+  get itemDownloadUrl(): string {
+    return this.$galleryStore.resourceRoot + this.item.properties.resource;
+  }
+}
+</script>
+
+<style lang="scss" module>
+.content {
+  text-align: center;
+}
+
+.icon {
+  margin-bottom: 0.15em;
+}
+</style>
diff --git a/viewer/src/components/item_handlers/LdPdfViewer.vue b/viewer/src/components/item_handlers/LdPdfViewer.vue
index 462c463..e55989a 100644
--- a/viewer/src/components/item_handlers/LdPdfViewer.vue
+++ b/viewer/src/components/item_handlers/LdPdfViewer.vue
@@ -30,11 +30,12 @@
 </template>
 
 <script lang="ts">
+import { PDFItem } from "@/@types/gallery";
 import { Component, Prop, Vue } from "vue-property-decorator";
 
 @Component
 export default class LdPdfViewer extends Vue {
-  @Prop({ required: true }) readonly item!: Gallery.PDF;
+  @Prop({ required: true }) readonly item!: PDFItem;
 
   get itemResourceUrl(): string {
     return this.$galleryStore.resourceRoot + this.item.properties.resource;
diff --git a/viewer/src/components/item_handlers/LdPicture.vue b/viewer/src/components/item_handlers/LdPicture.vue
deleted file mode 100644
index e652afc..0000000
--- a/viewer/src/components/item_handlers/LdPicture.vue
+++ /dev/null
@@ -1,127 +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/>.
--->
-
-<template>
-  <!-- FIXME: v-dragscroll interferes with pinch-to-zoom -->
-  <div
-    ref="containerElement"
-    v-dragscroll
-    class="scrollbar ld-picture-container"
-    @click.capture="e => dragScrollClickFix.onClickCapture(e)"
-    @dblclick="$uiStore.toggleFullscreen()"
-    @dragstart.prevent
-    @dragscrollstart="dragScrollClickFix.onDragScrollStart()"
-    @dragscrollend="dragScrollClickFix.onDragScrollEnd()"
-  >
-    <v-lazy-image
-      ref="imageElement"
-      :src="pictureSrc(item.properties.resource)"
-      class="ld-picture-element"
-      :class="{ 'slow-loading': Boolean(slowLoadingStyle) }"
-      :style="slowLoadingStyle"
-      @load="clearSlowLoading"
-    />
-    <b-loading :active="loader" :is-full-page="false" class="ld-picture-loader" />
-  </div>
-</template>
-
-<script lang="ts">
-import { Component, Vue, Prop, Ref } from "vue-property-decorator";
-import LdZoom from "@/services/ldzoom";
-import DragScrollClickFix from "@/services/dragscrollclickfix";
-
-@Component
-export default class LdPicture extends Vue {
-  @Prop({ required: true }) readonly item!: Gallery.Picture;
-  @Ref() readonly containerElement!: HTMLDivElement;
-  @Ref() readonly imageElement!: Vue;
-
-  readonly SLOW_LOADING_TIMEOUT_MS: number = 1500;
-  readonly dragScrollClickFix = new DragScrollClickFix();
-
-  slowLoadingStyle: string | null = null;
-  loader: boolean = false;
-  timer: NodeJS.Timeout | null = null;
-
-  mounted() {
-    this.timer = setTimeout(this.generateSlowLoadingStyle, this.SLOW_LOADING_TIMEOUT_MS);
-    new LdZoom(
-      this.containerElement,
-      this.imageElement.$el as HTMLImageElement,
-      this.item.properties,
-      10,
-      1 / 5
-    ).install();
-  }
-
-  destroyed() {
-    this.clearSlowLoading();
-  }
-
-  clearSlowLoading() {
-    if (this.timer) clearTimeout(this.timer);
-    this.timer = null;
-    this.slowLoadingStyle = null;
-    this.loader = false;
-  }
-
-  pictureSrc(resource: string) {
-    return this.$galleryStore.resourceRoot + resource;
-  }
-
-  generateSlowLoadingStyle() {
-    this.clearSlowLoading();
-    this.loader = true;
-    if (this.item.thumbnail) {
-      const url = this.pictureSrc(this.item.thumbnail.resource);
-      this.slowLoadingStyle = `background-image: url('${url}');`;
-    }
-  }
-}
-</script>
-
-<style lang="scss">
-@import "~@/assets/scss/theme.scss";
-
-.ld-picture-container {
-  height: 100%;
-}
-
-.ld-picture-element {
-  max-width: unset;
-  max-height: unset;
-  cursor: grab;
-}
-
-.slow-loading {
-  background-repeat: no-repeat;
-  background-position: center;
-  background-size: contain;
-  background-color: $content-bgcolor;
-  background-blend-mode: soft-light;
-  opacity: 1 !important;
-}
-
-.ld-picture-loader {
-  position: relative;
-  & .loading-background {
-    background: none !important;
-  }
-}
-</style>
diff --git a/viewer/src/components/item_handlers/LdPictureViewer.vue b/viewer/src/components/item_handlers/LdPictureViewer.vue
new file mode 100644
index 0000000..003ffe9
--- /dev/null
+++ b/viewer/src/components/item_handlers/LdPictureViewer.vue
@@ -0,0 +1,128 @@
+<!-- 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/>.
+-->
+
+<template>
+  <!-- FIXME: v-dragscroll interferes with pinch-to-zoom -->
+  <div
+    ref="containerElement"
+    v-dragscroll
+    class="scrollbar ld-picture-container"
+    @click.capture="e => dragScrollClickFix.onClickCapture(e)"
+    @dblclick="$uiStore.toggleFullscreen()"
+    @dragstart.prevent
+    @dragscrollstart="dragScrollClickFix.onDragScrollStart()"
+    @dragscrollend="dragScrollClickFix.onDragScrollEnd()"
+  >
+    <v-lazy-image
+      ref="imageElement"
+      :src="pictureSrc(item.properties.resource)"
+      class="ld-picture-element"
+      :class="{ 'slow-loading': Boolean(slowLoadingStyle) }"
+      :style="slowLoadingStyle"
+      @load="clearSlowLoading"
+    />
+    <b-loading :active="loader" :is-full-page="false" class="ld-picture-loader" />
+  </div>
+</template>
+
+<script lang="ts">
+import { PictureItem } from "@/@types/gallery";
+import DragScrollClickFix from "@/services/dragscrollclickfix";
+import LdZoom from "@/services/ldzoom";
+import { Component, Prop, Ref, Vue } from "vue-property-decorator";
+
+@Component
+export default class LdPictureViewer extends Vue {
+  @Prop({ required: true }) readonly item!: PictureItem;
+  @Ref() readonly containerElement!: HTMLDivElement;
+  @Ref() readonly imageElement!: Vue;
+
+  readonly SLOW_LOADING_TIMEOUT_MS: number = 1500;
+  readonly dragScrollClickFix = new DragScrollClickFix();
+
+  slowLoadingStyle: string | null = null;
+  loader: boolean = false;
+  timer: NodeJS.Timeout | null = null;
+
+  mounted() {
+    this.timer = setTimeout(this.generateSlowLoadingStyle, this.SLOW_LOADING_TIMEOUT_MS);
+    new LdZoom(
+      this.containerElement,
+      this.imageElement.$el as HTMLImageElement,
+      this.item.properties,
+      10,
+      1 / 5
+    ).install();
+  }
+
+  destroyed() {
+    this.clearSlowLoading();
+  }
+
+  clearSlowLoading() {
+    if (this.timer) clearTimeout(this.timer);
+    this.timer = null;
+    this.slowLoadingStyle = null;
+    this.loader = false;
+  }
+
+  pictureSrc(resource: string) {
+    return this.$galleryStore.resourceRoot + resource;
+  }
+
+  generateSlowLoadingStyle() {
+    this.clearSlowLoading();
+    this.loader = true;
+    if (this.item.thumbnail) {
+      const url = this.pictureSrc(this.item.thumbnail.resource);
+      this.slowLoadingStyle = `background-image: url('${url}');`;
+    }
+  }
+}
+</script>
+
+<style lang="scss">
+@import "~@/assets/scss/theme.scss";
+
+.ld-picture-container {
+  height: 100%;
+}
+
+.ld-picture-element {
+  max-width: unset;
+  max-height: unset;
+  cursor: grab;
+}
+
+.slow-loading {
+  background-repeat: no-repeat;
+  background-position: center;
+  background-size: contain;
+  background-color: $content-bgcolor;
+  background-blend-mode: soft-light;
+  opacity: 1 !important;
+}
+
+.ld-picture-loader {
+  position: relative;
+  & .loading-background {
+    background: none !important;
+  }
+}
+</style>
diff --git a/viewer/src/components/item_handlers/LdPlainTextViewer.vue b/viewer/src/components/item_handlers/LdPlainTextViewer.vue
index cd26d9d..79465d5 100644
--- a/viewer/src/components/item_handlers/LdPlainTextViewer.vue
+++ b/viewer/src/components/item_handlers/LdPlainTextViewer.vue
@@ -27,11 +27,12 @@
 </template>
 
 <script lang="ts">
+import { PlainTextItem } from "@/@types/gallery";
 import { Component, Prop, Vue } from "vue-property-decorator";
 
 @Component
 export default class LdPlainTextViewer extends Vue {
-  @Prop({ required: true }) readonly item!: Gallery.PlainText;
+  @Prop({ required: true }) readonly item!: PlainTextItem;
 
   get itemResourceUrl(): string {
     return this.$galleryStore.resourceRoot + this.item.properties.resource;
diff --git a/viewer/src/components/item_handlers/LdVideoViewer.vue b/viewer/src/components/item_handlers/LdVideoViewer.vue
index 2e3a43c..a203b13 100644
--- a/viewer/src/components/item_handlers/LdVideoViewer.vue
+++ b/viewer/src/components/item_handlers/LdVideoViewer.vue
@@ -28,11 +28,12 @@
 </template>
 
 <script lang="ts">
+import { VideoItem } from "@/@types/gallery";
 import { Component, Prop, Vue } from "vue-property-decorator";
 
 @Component
 export default class LdVideoViewer extends Vue {
-  @Prop({ required: true }) readonly item!: Gallery.Video;
+  @Prop({ required: true }) readonly item!: VideoItem;
 
   get itemResourceUrl(): string {
     return this.$galleryStore.resourceRoot + this.item.properties.resource;
-- 
cgit v1.2.3