optica-core 0.2.1 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optica-core",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Shared frontend core of the Optica viewers",
   "license": "GPL-3.0-or-later",
   "type": "module",

package/src/data/models/image.ts

@@ -1,7 +1,9 @@
 // Minimal image identity shared by every app (stack, rotation, spectral, ...)
 export type ImageName = {
     name: string,
-    label: string
+    label: string,
+    // sent by the backend when the thumbnail of this image exists
+    hasThumbnail?: boolean
 }
 
 // What an annotation keeps of its image: the name to find it back, the label and the

package/src/data/models/project.ts

@@ -11,7 +11,6 @@ export type AcquisitionObject<TImage extends ProjectImage = ProjectImage> = {
     // images on their own: the stacked results, the depth maps...
     standaloneImages?: TImage[]
     size: Size
-    thumbnails: boolean
 }
 
 // Images taken together, with the viewer state and the annotations of the acquisition.
@@ -22,7 +21,6 @@ export class Acquisition<TImage extends ProjectImage = ProjectImage, TAnnotation
     images: TImage[]
     standaloneImages: TImage[]
     size: Size
-    thumbnails: boolean
     camera: Camera
     // shared by the images of the group and the standalone ones
     annotations: TAnnotations
@@ -37,7 +35,6 @@ export class Acquisition<TImage extends ProjectImage = ProjectImage, TAnnotation
         this.images = object.images
         this.standaloneImages = object.standaloneImages ?? []
         this.size = object.size
-        this.thumbnails = object.thumbnails
         this.camera = createCamera()
         this.annotations = this.createAnnotations()
         this.index = 0
@@ -121,7 +118,6 @@ export class Acquisition<TImage extends ProjectImage = ProjectImage, TAnnotation
             images: this.images,
             standaloneImages: this.standaloneImages,
             size: this.size,
-            thumbnails: this.thumbnails,
         }
     }
 }

package/src/data/repositories/data_repository.ts

@@ -28,11 +28,12 @@ export abstract class DataRepository<TData> implements Repository<TData> {
         return this.provider.getThumbnail(objectPath, imageName)
     }
 
-    // Fill the image and thumbnail urls of images sent by /images
-    protected resolveUrls<T extends ImageName>(objectPath: string, images: T[], thumbnails: boolean): (T & ProjectImage)[] {
+    // Fill the image and thumbnail urls of images sent by /images,
+    // the thumbnail url only for the images the backend marks with `hasThumbnail`
+    protected resolveUrls<T extends ImageName>(objectPath: string, images: T[]): (T & ProjectImage)[] {
         return images.map((image) => Object.assign(image, {
             image: this.getFullImage(objectPath, image.name),
-            thumbnail: thumbnails ? this.getThumbnail(objectPath, image.name) : undefined,
+            thumbnail: image.hasThumbnail ? this.getThumbnail(objectPath, image.name) : undefined,
         }))
     }
 }

package/src/data/repositories/project_repository.ts

@@ -34,8 +34,8 @@ export class ProjectRepository<TImage extends ProjectImage = ProjectImage, TAcqu
     async getImages(objectPath: string): Promise<Project<TImage, TAcquisition>> {
         const res = await this.provider.getImages(objectPath)
         const acquisitions = this.parse(res.data).map((object) => {
-            object.images = this.resolveUrls(objectPath, object.images, object.thumbnails)
-            object.standaloneImages = this.resolveUrls(objectPath, object.standaloneImages ?? [], object.thumbnails)
+            object.images = this.resolveUrls(objectPath, object.images)
+            object.standaloneImages = this.resolveUrls(objectPath, object.standaloneImages ?? [])
             return this.createAcquisition(object)
         })
         return new Project<TImage, TAcquisition>(objectPath, acquisitions)

package/tests/annotations.test.ts

@@ -9,7 +9,7 @@ import {
 const size = { width: 100, height: 100 }
 const image = (name: string): ProjectImage => ({ name, label: name, image: "" })
 const landmark = (id: string, img = image("i0")) => new Landmark(id, id, { marker: { x: 1, y: 2 }, image: img }, { x: 10, y: 20 }, Color("#ff0000"))
-const acquisition = (id: string, names: string[] = ["i0"]) => new Acquisition({ id, images: names.map(image), size, thumbnails: false })
+const acquisition = (id: string, names: string[] = ["i0"]) => new Acquisition({ id, images: names.map(image), size })
 
 describe("Annotations", () => {
   it("creates a selected distance and returns the reactive copy through a store", () => {
@@ -88,7 +88,7 @@ class TaggedAcquisition extends Acquisition<ProjectImage> {
 
 describe("Project annotations", () => {
   it("lets an app use its own Annotations", () => {
-    const a = new TaggedAcquisition({ id: "a", images: [image("i0")], size, thumbnails: false })
+    const a = new TaggedAcquisition({ id: "a", images: [image("i0")], size })
     expect(a.annotations.tagged).toBe(true)
     a.annotations.restore({ distances: [{ label: "d", color: "#00ff00", landmarks: [], value: 0 }] })
     expect(a.annotations.distances[0]).toBeInstanceOf(Distance)

package/tests/project.test.ts

@@ -6,7 +6,7 @@ const size = { width: 2000, height: 1000 }
 const img = (name: string, extra = {}): ProjectImage => ({ name, label: name, image: "", ...extra })
 
 function acquisition(images: string[], standalone: string[] = []): Acquisition {
-  return new Acquisition({ id: "a", images: images.map((n) => img(n)), standaloneImages: standalone.map((n) => img(n)), size, thumbnails: false })
+  return new Acquisition({ id: "a", images: images.map((n) => img(n)), standaloneImages: standalone.map((n) => img(n)), size })
 }
 
 describe("Acquisition", () => {
@@ -42,7 +42,7 @@ describe("Acquisition", () => {
   })
 
   it("uses the size of the image when it has one", () => {
-    const a = new Acquisition({ id: "a", images: [], standaloneImages: [img("d0", { size: { width: 5, height: 5 } }), img("d1")], size, thumbnails: false })
+    const a = new Acquisition({ id: "a", images: [], standaloneImages: [img("d0", { size: { width: 5, height: 5 } }), img("d1")], size })
     expect(a.sizeOf()).toEqual({ width: 5, height: 5 })
     expect(a.sizeOf(a.getImage("d1"))).toEqual(size)
   })
@@ -50,8 +50,8 @@ describe("Acquisition", () => {
 
 describe("Project", () => {
   it("selects acquisitions and finds images", () => {
-    const vis = new Acquisition({ id: "VIS", images: [img("vis0")], size, thumbnails: false })
-    const uv = new Acquisition({ id: "UV", images: [img("uv0")], standaloneImages: [img("uvRGB")], size, thumbnails: false })
+    const vis = new Acquisition({ id: "VIS", images: [img("vis0")], size })
+    const uv = new Acquisition({ id: "UV", images: [img("uv0")], standaloneImages: [img("uvRGB")], size })
     const p = new Project("A1", [vis, uv])
     expect(p.selectedImage?.name).toBe("vis0")
     p.selectAcquisition("UV")
@@ -75,21 +75,32 @@ function provider(data: unknown): DataProvider {
 
 describe("ProjectRepository", () => {
   it("reads the standard payload and resolves the urls", async () => {
-    const payload = { acquisitions: [{ id: "stack", images: [{ name: "s0", label: "s0" }], standaloneImages: [{ name: "r", label: "Result" }], size, thumbnails: true }] }
+    const payload = { acquisitions: [{ id: "stack", images: [{ name: "s0", label: "s0", hasThumbnail: true }], standaloneImages: [{ name: "r", label: "Result" }], size }] }
     const project = await new ProjectRepository(provider(payload)).getImages("A1")
     const a = project.acquisition!
     expect(a.images[0]).toMatchObject({ image: "S/A1/s0/full-image", thumbnail: "S/A1/s0/thumbnail" })
     expect(a.standaloneImages[0]).toMatchObject({ label: "Result", image: "S/A1/r/full-image" })
   })
 
+  it("resolves the thumbnail of the images marked with hasThumbnail only", async () => {
+    const payload = { acquisitions: [{
+      id: "stack", size,
+      images: [{ name: "s0", label: "s0", hasThumbnail: true }, { name: "s1", label: "s1", hasThumbnail: false }, { name: "s2", label: "s2" }],
+      standaloneImages: [{ name: "r", label: "Result", hasThumbnail: true }],
+    }] }
+    const a = (await new ProjectRepository(provider(payload)).getImages("A1")).acquisition!
+    expect(a.images.map((image) => image.thumbnail)).toEqual(["S/A1/s0/thumbnail", undefined, undefined])
+    expect(a.standaloneImages[0].thumbnail).toBe("S/A1/r/thumbnail")
+  })
+
   it("adapts a legacy payload with a parser (spectral: one acquisition per group)", async () => {
     type SpectralImage = ProjectImage & { wavelength: { value: number } }
     const legacy = {
-      VIS: { spectralImages: [{ name: "v450", label: "v450", wavelength: { value: 450 } }], individualImages: { RGB: { name: "vRGB", label: "RGB" } }, size, thumbnails: false },
-      UV: { spectralImages: [], individualImages: { RGB: { name: "uRGB", label: "RGB" } }, size, thumbnails: false },
+      VIS: { spectralImages: [{ name: "v450", label: "v450", wavelength: { value: 450 } }], individualImages: { RGB: { name: "vRGB", label: "RGB" } }, size },
+      UV: { spectralImages: [], individualImages: { RGB: { name: "uRGB", label: "RGB" } }, size },
     }
     const parse = (data: any): AcquisitionObject<SpectralImage>[] => Object.entries<any>(data).map(([id, group]) => ({
-      id, images: group.spectralImages, standaloneImages: Object.values(group.individualImages), size: group.size, thumbnails: group.thumbnails,
+      id, images: group.spectralImages, standaloneImages: Object.values(group.individualImages), size: group.size,
     }))
     const project = await new ProjectRepository<SpectralImage>(provider(legacy), parse).getImages("A1")
     expect(project.acquisitions.map((a) => a.id)).toEqual(["VIS", "UV"])
@@ -99,9 +110,9 @@ describe("ProjectRepository", () => {
   })
 
   it("adapts depth: no group, standalone images with their own size", async () => {
-    const legacy = { images: [{ id: "d0", label: "D0", size: { width: 10, height: 20 } }], thumbnails: false }
+    const legacy = { images: [{ id: "d0", label: "D0", size: { width: 10, height: 20 } }] }
     const parse = (data: any): AcquisitionObject[] => [{
-      id: "depth", images: [], size: data.images[0].size, thumbnails: data.thumbnails,
+      id: "depth", images: [], size: data.images[0].size,
       standaloneImages: data.images.map((i: any) => ({ name: i.id, label: i.label, size: i.size })),
     }]
     const project = await new ProjectRepository(provider(legacy), parse).getImages("A1")