@digitalculture/ochre-sdk 0.1.29 → 0.2.0

package/dist/index.cjs

@@ -587,17 +587,15 @@ var componentSchema = import_zod3.z.enum(
     "iiif-viewer",
     "image",
     "image-gallery",
-    "interactive-chapter-table",
     "item-gallery",
-    "menu",
-    "menu-item",
     "n-columns",
     "n-rows",
     "network-graph",
     "table",
     "text",
     "text-image",
-    "timeline"
+    "timeline",
+    "video"
   ],
   { message: "Invalid component" }
 );
@@ -1468,12 +1466,44 @@ async function parseWebElementProperties(componentProperty, elementResource) {
           `Image link not found for the following component: \u201C${componentName}\u201D`
         );
       }
+      let captionLayout = getPropertyValueByLabel(
+        componentProperty.properties,
+        "caption-layout"
+      );
+      if (captionLayout === null) {
+        captionLayout = "bottom";
+      }
+      let imageQuality = getPropertyValueByLabel(
+        componentProperty.properties,
+        "image-quality"
+      );
+      if (imageQuality === null) {
+        imageQuality = "high";
+      }
+      let captionSource = getPropertyValueByLabel(
+        componentProperty.properties,
+        "caption-source"
+      );
+      if (captionSource === null) {
+        captionSource = "name";
+      }
+      let altTextSource = getPropertyValueByLabel(
+        componentProperty.properties,
+        "alt-text-source"
+      );
+      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
       };
+      properties.imageQuality = imageQuality;
+      properties.captionLayout = captionLayout;
+      properties.captionSource = captionSource;
+      properties.altTextSource = altTextSource;
       break;
     }
     case "image-gallery": {
@@ -1486,9 +1516,6 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.galleryId = galleryLink.uuid;
       break;
     }
-    case "interactive-chapter-table": {
-      break;
-    }
     case "item-gallery": {
       const galleryLink = links.find((link) => link.category === "tree");
       if (!galleryLink) {
@@ -1499,12 +1526,6 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.galleryId = galleryLink.uuid;
       break;
     }
-    case "menu": {
-      break;
-    }
-    case "menu-item": {
-      break;
-    }
     case "n-columns": {
       const subElements = elementResource.resource ? await parseWebpageResources(
         Array.isArray(elementResource.resource) ? elementResource.resource : [elementResource.resource],
@@ -1588,17 +1609,40 @@ async function parseWebElementProperties(componentProperty, elementResource) {
           )}`
         );
       }
+      let imageQuality = getPropertyValueByLabel(
+        componentProperty.properties,
+        "image-quality"
+      );
+      if (imageQuality === null) {
+        imageQuality = "high";
+      }
+      let captionSource = getPropertyValueByLabel(
+        componentProperty.properties,
+        "caption-source"
+      );
+      if (captionSource === null) {
+        captionSource = "name";
+      }
+      let altTextSource = getPropertyValueByLabel(
+        componentProperty.properties,
+        "alt-text-source"
+      );
+      if (altTextSource === null) {
+        altTextSource = "name";
+      }
       properties.variant = variant;
-      properties.layout = layout;
-      properties.captionLayout = captionLayout;
-      properties.content = document.content;
       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
       };
-      properties.imageOpacity = null;
+      properties.imageQuality = imageQuality;
+      properties.layout = layout;
+      properties.captionSource = captionSource;
+      properties.captionLayout = captionLayout;
+      properties.altTextSource = altTextSource;
+      properties.content = document.content;
       break;
     }
     case "timeline": {
@@ -1611,12 +1655,31 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.timelineId = timelineLink.uuid;
       break;
     }
+    case "video": {
+      const videoLink = links.find((link) => link.type === "video");
+      if (!videoLink) {
+        throw new Error(
+          `Video link not found for the following component: \u201C${componentName}\u201D`
+        );
+      }
+      let isChaptersDislayed = getPropertyValueByLabel(
+        componentProperty.properties,
+        "chapters-displayed"
+      );
+      if (isChaptersDislayed == null) {
+        isChaptersDislayed = "Yes";
+      }
+      properties.videoId = videoLink.uuid;
+      properties.isChaptersDislayed = isChaptersDislayed === "Yes";
+      break;
+    }
     default: {
       console.warn(
         `Invalid or non-implemented component name \u201C${componentName}\u201D for the following element: \u201C${parseStringContent(
           elementResource.identification.label
         )}\u201D`
       );
+      break;
     }
   }
   return properties;
@@ -1646,9 +1709,49 @@ async function parseWebElement(elementResource, elementProperties) {
     const cssStyle = property.values[0].content;
     cssStyles.push({ label: property.label, value: cssStyle });
   }
+  const titleProperties = elementResourceProperties.find(
+    (property) => property.label === "title"
+  )?.properties;
+  let variant = "default";
+  let isNameDisplayed = false;
+  let isDescriptionDisplayed = false;
+  let isDateDisplayed = false;
+  let isCreatorsDisplayed = false;
+  if (titleProperties) {
+    const titleVariant = getPropertyValueByLabel(titleProperties, "variant");
+    if (titleVariant) {
+      variant = titleVariant;
+    }
+    const titleShow = titleProperties.filter(
+      (property) => property.label === "display"
+    );
+    if (titleShow.length > 0) {
+      isNameDisplayed = titleShow.some(
+        (property) => property.values[0].content === "name"
+      );
+      isDescriptionDisplayed = titleShow.some(
+        (property) => property.values[0].content === "description"
+      );
+      isDateDisplayed = titleShow.some(
+        (property) => property.values[0].content === "date"
+      );
+      isCreatorsDisplayed = titleShow.some(
+        (property) => property.values[0].content === "creators"
+      );
+    }
+  }
   return {
     uuid: elementResource.uuid,
-    title: identification.label,
+    title: {
+      label: identification.label,
+      variant,
+      properties: {
+        isNameDisplayed,
+        isDescriptionDisplayed,
+        isDateDisplayed,
+        isCreatorsDisplayed
+      }
+    },
     cssStyles,
     ...properties
   };

package/dist/index.d.cts

@@ -442,7 +442,16 @@ type WebpageProperties = {
  */
 type WebElement = {
     uuid: string;
-    title: string;
+    title: {
+        label: string;
+        variant: "default" | "simple";
+        properties: {
+            isNameDisplayed: boolean;
+            isDescriptionDisplayed: boolean;
+            isDateDisplayed: boolean;
+            isCreatorsDisplayed: boolean;
+        };
+    };
     cssStyles: Array<Style>;
 } & WebElementComponent;
 /**
@@ -454,6 +463,7 @@ type WebElementComponent = {
 } | {
     component: "annotated-image";
     imageUuid: string;
+    isSearchable: boolean;
 } | {
     component: "bibliography";
     bibliographies: Array<Bibliography>;
@@ -476,19 +486,18 @@ type WebElementComponent = {
     IIIFId: string;
 } | {
     component: "image";
-    image: WebImage;
+    variant: "default" | "carousel";
+    images: Array<WebImage>;
+    imageQuality: "high" | "low";
+    captionSource: "name" | "abbreviation" | "description";
+    captionLayout: "top" | "bottom" | "suppress";
+    altTextSource: "name" | "abbreviation" | "description";
 } | {
     component: "image-gallery";
     galleryId: string;
-} | {
-    component: "interactive-chapter-table";
 } | {
     component: "item-gallery";
     galleryId: string;
-} | {
-    component: "menu";
-} | {
-    component: "menu-item";
 } | {
     component: "n-columns";
     columns: Array<WebElement>;
@@ -507,14 +516,19 @@ type WebElementComponent = {
 } | {
     component: "text-image";
     variant: "title" | "block" | "banner";
+    image: WebImage;
+    imageQuality: "high" | "low";
     layout: "image-top" | "image-bottom" | "image-start" | "image-end" | "image-background";
+    captionSource: "name" | "abbreviation" | "description";
     captionLayout: "top" | "bottom" | "suppress";
-    image: WebImage;
-    imageOpacity: number | null;
+    altTextSource: "name" | "abbreviation" | "description";
     content: string;
 } | {
     component: "timeline";
     timelineId: string;
+} | {
+    component: "video";
+    isChaptersDislayed: boolean;
 };
 /**
  * Represents an image used in web elements

package/dist/index.d.ts

@@ -442,7 +442,16 @@ type WebpageProperties = {
  */
 type WebElement = {
     uuid: string;
-    title: string;
+    title: {
+        label: string;
+        variant: "default" | "simple";
+        properties: {
+            isNameDisplayed: boolean;
+            isDescriptionDisplayed: boolean;
+            isDateDisplayed: boolean;
+            isCreatorsDisplayed: boolean;
+        };
+    };
     cssStyles: Array<Style>;
 } & WebElementComponent;
 /**
@@ -454,6 +463,7 @@ type WebElementComponent = {
 } | {
     component: "annotated-image";
     imageUuid: string;
+    isSearchable: boolean;
 } | {
     component: "bibliography";
     bibliographies: Array<Bibliography>;
@@ -476,19 +486,18 @@ type WebElementComponent = {
     IIIFId: string;
 } | {
     component: "image";
-    image: WebImage;
+    variant: "default" | "carousel";
+    images: Array<WebImage>;
+    imageQuality: "high" | "low";
+    captionSource: "name" | "abbreviation" | "description";
+    captionLayout: "top" | "bottom" | "suppress";
+    altTextSource: "name" | "abbreviation" | "description";
 } | {
     component: "image-gallery";
     galleryId: string;
-} | {
-    component: "interactive-chapter-table";
 } | {
     component: "item-gallery";
     galleryId: string;
-} | {
-    component: "menu";
-} | {
-    component: "menu-item";
 } | {
     component: "n-columns";
     columns: Array<WebElement>;
@@ -507,14 +516,19 @@ type WebElementComponent = {
 } | {
     component: "text-image";
     variant: "title" | "block" | "banner";
+    image: WebImage;
+    imageQuality: "high" | "low";
     layout: "image-top" | "image-bottom" | "image-start" | "image-end" | "image-background";
+    captionSource: "name" | "abbreviation" | "description";
     captionLayout: "top" | "bottom" | "suppress";
-    image: WebImage;
-    imageOpacity: number | null;
+    altTextSource: "name" | "abbreviation" | "description";
     content: string;
 } | {
     component: "timeline";
     timelineId: string;
+} | {
+    component: "video";
+    isChaptersDislayed: boolean;
 };
 /**
  * Represents an image used in web elements

package/dist/index.js

@@ -510,17 +510,15 @@ var componentSchema = z3.enum(
     "iiif-viewer",
     "image",
     "image-gallery",
-    "interactive-chapter-table",
     "item-gallery",
-    "menu",
-    "menu-item",
     "n-columns",
     "n-rows",
     "network-graph",
     "table",
     "text",
     "text-image",
-    "timeline"
+    "timeline",
+    "video"
   ],
   { message: "Invalid component" }
 );
@@ -1391,12 +1389,44 @@ async function parseWebElementProperties(componentProperty, elementResource) {
           `Image link not found for the following component: \u201C${componentName}\u201D`
         );
       }
+      let captionLayout = getPropertyValueByLabel(
+        componentProperty.properties,
+        "caption-layout"
+      );
+      if (captionLayout === null) {
+        captionLayout = "bottom";
+      }
+      let imageQuality = getPropertyValueByLabel(
+        componentProperty.properties,
+        "image-quality"
+      );
+      if (imageQuality === null) {
+        imageQuality = "high";
+      }
+      let captionSource = getPropertyValueByLabel(
+        componentProperty.properties,
+        "caption-source"
+      );
+      if (captionSource === null) {
+        captionSource = "name";
+      }
+      let altTextSource = getPropertyValueByLabel(
+        componentProperty.properties,
+        "alt-text-source"
+      );
+      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
       };
+      properties.imageQuality = imageQuality;
+      properties.captionLayout = captionLayout;
+      properties.captionSource = captionSource;
+      properties.altTextSource = altTextSource;
       break;
     }
     case "image-gallery": {
@@ -1409,9 +1439,6 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.galleryId = galleryLink.uuid;
       break;
     }
-    case "interactive-chapter-table": {
-      break;
-    }
     case "item-gallery": {
       const galleryLink = links.find((link) => link.category === "tree");
       if (!galleryLink) {
@@ -1422,12 +1449,6 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.galleryId = galleryLink.uuid;
       break;
     }
-    case "menu": {
-      break;
-    }
-    case "menu-item": {
-      break;
-    }
     case "n-columns": {
       const subElements = elementResource.resource ? await parseWebpageResources(
         Array.isArray(elementResource.resource) ? elementResource.resource : [elementResource.resource],
@@ -1511,17 +1532,40 @@ async function parseWebElementProperties(componentProperty, elementResource) {
           )}`
         );
       }
+      let imageQuality = getPropertyValueByLabel(
+        componentProperty.properties,
+        "image-quality"
+      );
+      if (imageQuality === null) {
+        imageQuality = "high";
+      }
+      let captionSource = getPropertyValueByLabel(
+        componentProperty.properties,
+        "caption-source"
+      );
+      if (captionSource === null) {
+        captionSource = "name";
+      }
+      let altTextSource = getPropertyValueByLabel(
+        componentProperty.properties,
+        "alt-text-source"
+      );
+      if (altTextSource === null) {
+        altTextSource = "name";
+      }
       properties.variant = variant;
-      properties.layout = layout;
-      properties.captionLayout = captionLayout;
-      properties.content = document.content;
       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
       };
-      properties.imageOpacity = null;
+      properties.imageQuality = imageQuality;
+      properties.layout = layout;
+      properties.captionSource = captionSource;
+      properties.captionLayout = captionLayout;
+      properties.altTextSource = altTextSource;
+      properties.content = document.content;
       break;
     }
     case "timeline": {
@@ -1534,12 +1578,31 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       properties.timelineId = timelineLink.uuid;
       break;
     }
+    case "video": {
+      const videoLink = links.find((link) => link.type === "video");
+      if (!videoLink) {
+        throw new Error(
+          `Video link not found for the following component: \u201C${componentName}\u201D`
+        );
+      }
+      let isChaptersDislayed = getPropertyValueByLabel(
+        componentProperty.properties,
+        "chapters-displayed"
+      );
+      if (isChaptersDislayed == null) {
+        isChaptersDislayed = "Yes";
+      }
+      properties.videoId = videoLink.uuid;
+      properties.isChaptersDislayed = isChaptersDislayed === "Yes";
+      break;
+    }
     default: {
       console.warn(
         `Invalid or non-implemented component name \u201C${componentName}\u201D for the following element: \u201C${parseStringContent(
           elementResource.identification.label
         )}\u201D`
       );
+      break;
     }
   }
   return properties;
@@ -1569,9 +1632,49 @@ async function parseWebElement(elementResource, elementProperties) {
     const cssStyle = property.values[0].content;
     cssStyles.push({ label: property.label, value: cssStyle });
   }
+  const titleProperties = elementResourceProperties.find(
+    (property) => property.label === "title"
+  )?.properties;
+  let variant = "default";
+  let isNameDisplayed = false;
+  let isDescriptionDisplayed = false;
+  let isDateDisplayed = false;
+  let isCreatorsDisplayed = false;
+  if (titleProperties) {
+    const titleVariant = getPropertyValueByLabel(titleProperties, "variant");
+    if (titleVariant) {
+      variant = titleVariant;
+    }
+    const titleShow = titleProperties.filter(
+      (property) => property.label === "display"
+    );
+    if (titleShow.length > 0) {
+      isNameDisplayed = titleShow.some(
+        (property) => property.values[0].content === "name"
+      );
+      isDescriptionDisplayed = titleShow.some(
+        (property) => property.values[0].content === "description"
+      );
+      isDateDisplayed = titleShow.some(
+        (property) => property.values[0].content === "date"
+      );
+      isCreatorsDisplayed = titleShow.some(
+        (property) => property.values[0].content === "creators"
+      );
+    }
+  }
   return {
     uuid: elementResource.uuid,
-    title: identification.label,
+    title: {
+      label: identification.label,
+      variant,
+      properties: {
+        isNameDisplayed,
+        isDescriptionDisplayed,
+        isDateDisplayed,
+        isCreatorsDisplayed
+      }
+    },
     cssStyles,
     ...properties
   };

package/package.json

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