@digitalculture/ochre-sdk 0.2.0 → 0.2.2

package/dist/index.cjs

@@ -1327,7 +1327,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
   const links = elementResource.links ? parseLinks(
     Array.isArray(elementResource.links) ? elementResource.links : [elementResource.links]
   ) : [];
-  const imageLink = links.find((link) => link.type === "image");
+  const imageLinks = links.filter((link) => link.type === "image");
   let document = elementResource.document ? parseDocument(elementResource.document.content) : null;
   if (document === null) {
     const documentLink = links.find((link) => link.type === "internalDocument");
@@ -1350,19 +1350,16 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "annotated-image": {
-      if (!imageLink) {
+      if (imageLinks.length === 0) {
         throw new Error(
           `Image link not found for the following component: \u201C${componentName}\u201D`
         );
       }
-      let isSearchable = getPropertyValueByLabel(
+      const isSearchable = getPropertyValueByLabel(
         componentProperty.properties,
         "is-searchable"
       ) === "Yes";
-      if (!isSearchable) {
-        isSearchable = false;
-      }
-      properties.imageUuid = imageLink.uuid;
+      properties.imageUuid = imageLinks[0].uuid;
       properties.isSearchable = isSearchable;
       break;
     }
@@ -1461,7 +1458,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "image": {
-      if (!imageLink) {
+      if (imageLinks.length === 0) {
         throw new Error(
           `Image link not found for the following component: \u201C${componentName}\u201D`
         );
@@ -1494,12 +1491,16 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (altTextSource === null) {
         altTextSource = "name";
       }
-      properties.image = {
-        url: `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&load`,
-        label: imageLink.identification?.label ?? null,
-        width: imageLink.image?.width ?? 0,
-        height: imageLink.image?.height ?? 0
-      };
+      const images = [];
+      for (const imageLink of imageLinks) {
+        images.push({
+          url: `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&load`,
+          label: imageLink.identification?.label ?? null,
+          width: imageLink.image?.width ?? 0,
+          height: imageLink.image?.height ?? 0
+        });
+      }
+      properties.images = images;
       properties.imageQuality = imageQuality;
       properties.captionLayout = captionLayout;
       properties.captionSource = captionSource;
@@ -1513,7 +1514,12 @@ async function parseWebElementProperties(componentProperty, elementResource) {
           `Image gallery link not found for the following component: \u201C${componentName}\u201D`
         );
       }
+      const isSearchable = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-searchable"
+      ) === "Yes";
       properties.galleryId = galleryLink.uuid;
+      properties.isSearchable = isSearchable;
       break;
     }
     case "item-gallery": {
@@ -1523,7 +1529,12 @@ async function parseWebElementProperties(componentProperty, elementResource) {
           `Item gallery link not found for the following component: \u201C${componentName}\u201D`
         );
       }
+      const isSearchable = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-searchable"
+      ) === "Yes";
       properties.galleryId = galleryLink.uuid;
+      properties.isSearchable = isSearchable;
       break;
     }
     case "n-columns": {
@@ -1599,10 +1610,10 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (captionLayout === null) {
         captionLayout = "bottom";
       }
-      const imageLink2 = links.find(
+      const imageLink = links.find(
         (link) => link.type === "image" || link.type === "IIIF"
       );
-      if (!imageLink2) {
+      if (!imageLink) {
         throw new Error(
           `Image link not found for the following component: \u201C${componentName}\u201D: ${JSON.stringify(
             links
@@ -1632,10 +1643,10 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       }
       properties.variant = variant;
       properties.image = {
-        url: `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink2.uuid}&preview`,
-        label: imageLink2.identification?.label ?? null,
-        width: imageLink2.image?.width ?? 0,
-        height: imageLink2.image?.height ?? 0
+        url: `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&preview`,
+        label: imageLink.identification?.label ?? null,
+        width: imageLink.image?.width ?? 0,
+        height: imageLink.image?.height ?? 0
       };
       properties.imageQuality = imageQuality;
       properties.layout = layout;

package/dist/index.d.cts

@@ -478,9 +478,10 @@ type WebElementComponent = {
     label: string;
 } | {
     component: "collection";
+    collectionId: string;
     variant: "full" | "highlights";
     layout: "image-top" | "image-bottom" | "image-start" | "image-end";
-    collectionId: string;
+    isSearchable: boolean;
 } | {
     component: "iiif-viewer";
     IIIFId: string;
@@ -495,9 +496,11 @@ type WebElementComponent = {
 } | {
     component: "image-gallery";
     galleryId: string;
+    isSearchable: boolean;
 } | {
     component: "item-gallery";
     galleryId: string;
+    isSearchable: boolean;
 } | {
     component: "n-columns";
     columns: Array<WebElement>;

package/dist/index.d.ts

@@ -478,9 +478,10 @@ type WebElementComponent = {
     label: string;
 } | {
     component: "collection";
+    collectionId: string;
     variant: "full" | "highlights";
     layout: "image-top" | "image-bottom" | "image-start" | "image-end";
-    collectionId: string;
+    isSearchable: boolean;
 } | {
     component: "iiif-viewer";
     IIIFId: string;
@@ -495,9 +496,11 @@ type WebElementComponent = {
 } | {
     component: "image-gallery";
     galleryId: string;
+    isSearchable: boolean;
 } | {
     component: "item-gallery";
     galleryId: string;
+    isSearchable: boolean;
 } | {
     component: "n-columns";
     columns: Array<WebElement>;

package/dist/index.js

@@ -1250,7 +1250,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
   const links = elementResource.links ? parseLinks(
     Array.isArray(elementResource.links) ? elementResource.links : [elementResource.links]
   ) : [];
-  const imageLink = links.find((link) => link.type === "image");
+  const imageLinks = links.filter((link) => link.type === "image");
   let document = elementResource.document ? parseDocument(elementResource.document.content) : null;
   if (document === null) {
     const documentLink = links.find((link) => link.type === "internalDocument");
@@ -1273,19 +1273,16 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "annotated-image": {
-      if (!imageLink) {
+      if (imageLinks.length === 0) {
         throw new Error(
           `Image link not found for the following component: \u201C${componentName}\u201D`
         );
       }
-      let isSearchable = getPropertyValueByLabel(
+      const isSearchable = getPropertyValueByLabel(
         componentProperty.properties,
         "is-searchable"
       ) === "Yes";
-      if (!isSearchable) {
-        isSearchable = false;
-      }
-      properties.imageUuid = imageLink.uuid;
+      properties.imageUuid = imageLinks[0].uuid;
       properties.isSearchable = isSearchable;
       break;
     }
@@ -1384,7 +1381,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       break;
     }
     case "image": {
-      if (!imageLink) {
+      if (imageLinks.length === 0) {
         throw new Error(
           `Image link not found for the following component: \u201C${componentName}\u201D`
         );
@@ -1417,12 +1414,16 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (altTextSource === null) {
         altTextSource = "name";
       }
-      properties.image = {
-        url: `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&load`,
-        label: imageLink.identification?.label ?? null,
-        width: imageLink.image?.width ?? 0,
-        height: imageLink.image?.height ?? 0
-      };
+      const images = [];
+      for (const imageLink of imageLinks) {
+        images.push({
+          url: `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&load`,
+          label: imageLink.identification?.label ?? null,
+          width: imageLink.image?.width ?? 0,
+          height: imageLink.image?.height ?? 0
+        });
+      }
+      properties.images = images;
       properties.imageQuality = imageQuality;
       properties.captionLayout = captionLayout;
       properties.captionSource = captionSource;
@@ -1436,7 +1437,12 @@ async function parseWebElementProperties(componentProperty, elementResource) {
           `Image gallery link not found for the following component: \u201C${componentName}\u201D`
         );
       }
+      const isSearchable = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-searchable"
+      ) === "Yes";
       properties.galleryId = galleryLink.uuid;
+      properties.isSearchable = isSearchable;
       break;
     }
     case "item-gallery": {
@@ -1446,7 +1452,12 @@ async function parseWebElementProperties(componentProperty, elementResource) {
           `Item gallery link not found for the following component: \u201C${componentName}\u201D`
         );
       }
+      const isSearchable = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-searchable"
+      ) === "Yes";
       properties.galleryId = galleryLink.uuid;
+      properties.isSearchable = isSearchable;
       break;
     }
     case "n-columns": {
@@ -1522,10 +1533,10 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (captionLayout === null) {
         captionLayout = "bottom";
       }
-      const imageLink2 = links.find(
+      const imageLink = links.find(
         (link) => link.type === "image" || link.type === "IIIF"
       );
-      if (!imageLink2) {
+      if (!imageLink) {
         throw new Error(
           `Image link not found for the following component: \u201C${componentName}\u201D: ${JSON.stringify(
             links
@@ -1555,10 +1566,10 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       }
       properties.variant = variant;
       properties.image = {
-        url: `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink2.uuid}&preview`,
-        label: imageLink2.identification?.label ?? null,
-        width: imageLink2.image?.width ?? 0,
-        height: imageLink2.image?.height ?? 0
+        url: `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&preview`,
+        label: imageLink.identification?.label ?? null,
+        width: imageLink.image?.width ?? 0,
+        height: imageLink.image?.height ?? 0
       };
       properties.imageQuality = imageQuality;
       properties.layout = layout;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",