@digitalculture/ochre-sdk 0.2.8 → 0.2.10

package/dist/index.cjs

@@ -1548,7 +1548,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (altTextSource === null) {
         altTextSource = "name";
       }
-      let secondsPerImage = images.length > 1 ? 5 : null;
+      let secondsPerImage = 5;
       const secondsPerImageProperty = getPropertyValueByLabel(
         componentProperty.properties,
         "seconds-per-image"
@@ -1574,13 +1574,15 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       }
       properties.images = images;
       properties.variant = variant;
+      properties.carouselOptions = images.length > 1 ? {
+        secondsPerImage,
+        isFullWidth,
+        isFullHeight
+      } : null;
       properties.imageQuality = imageQuality;
       properties.captionLayout = captionLayout;
       properties.captionSource = captionSource;
       properties.altTextSource = altTextSource;
-      properties.secondsPerImage = secondsPerImage;
-      properties.isFullWidth = isFullWidth;
-      properties.isFullHeight = isFullHeight;
       break;
     }
     case "image-gallery": {
@@ -1967,9 +1969,12 @@ function parseWebsiteProperties(properties) {
   const logoUuid = websiteProperties.find((property) => property.label === "logo")?.values[0]?.uuid ?? null;
   let isHeaderDisplayed = true;
   let headerVariant = "default";
+  let headerAlignment = "start";
+  let isHeaderProjectDisplayed = true;
   let isFooterDisplayed = true;
   let isSidebarDisplayed = false;
   let searchCollectionUuid = null;
+  let supportsThemeToggle = true;
   const headerProperty = websiteProperties.find(
     (property) => property.label === "navbar-visible"
   )?.values[0];
@@ -1982,6 +1987,18 @@ function parseWebsiteProperties(properties) {
   if (headerVariantProperty) {
     headerVariant = headerVariantProperty.content;
   }
+  const headerAlignmentProperty = websiteProperties.find(
+    (property) => property.label === "navbar-alignment"
+  )?.values[0];
+  if (headerAlignmentProperty) {
+    headerAlignment = headerAlignmentProperty.content;
+  }
+  const isHeaderProjectDisplayedProperty = websiteProperties.find(
+    (property) => property.label === "navbar-project-visible"
+  )?.values[0];
+  if (isHeaderProjectDisplayedProperty) {
+    isHeaderProjectDisplayed = isHeaderProjectDisplayedProperty.content === "Yes";
+  }
   const footerProperty = websiteProperties.find(
     (property) => property.label === "footer-visible"
   )?.values[0];
@@ -2000,6 +2017,12 @@ function parseWebsiteProperties(properties) {
   if (collectionSearchProperty) {
     searchCollectionUuid = collectionSearchProperty.uuid;
   }
+  const supportsThemeToggleProperty = websiteProperties.find(
+    (property) => property.label === "supports-theme-toggle"
+  )?.values[0];
+  if (supportsThemeToggleProperty) {
+    supportsThemeToggle = supportsThemeToggleProperty.content === "Yes";
+  }
   const {
     type: validatedType,
     status: validatedStatus,
@@ -2011,8 +2034,11 @@ function parseWebsiteProperties(properties) {
     status: validatedStatus,
     isHeaderDisplayed,
     headerVariant,
+    headerAlignment,
+    isHeaderProjectDisplayed,
     isFooterDisplayed,
     isSidebarDisplayed,
+    supportsThemeToggle,
     searchCollectionUuid,
     logoUrl: logoUuid !== null ? `https://ochre.lib.uchicago.edu/ochre?uuid=${logoUuid}&load` : null
   };

package/dist/index.d.cts

@@ -421,8 +421,11 @@ type WebsiteProperties = {
     status: "development" | "preview" | "production";
     isHeaderDisplayed: boolean;
     headerVariant: "default" | "floating";
+    headerAlignment: "start" | "center" | "end";
+    isHeaderProjectDisplayed: boolean;
     isFooterDisplayed: boolean;
     isSidebarDisplayed: boolean;
+    supportsThemeToggle: boolean;
     searchCollectionUuid: string | null;
     logoUrl: string | null;
 };
@@ -493,15 +496,17 @@ type WebElementComponent = {
     IIIFId: string;
 } | {
     component: "image";
-    variant: "default" | "carousel";
     images: Array<WebImage>;
+    variant: "default" | "carousel";
+    carouselOptions: {
+        secondsPerImage: number | null;
+        isFullWidth: boolean | null;
+        isFullHeight: boolean | null;
+    } | null;
     imageQuality: "high" | "low";
     captionSource: "name" | "abbreviation" | "description";
     captionLayout: "top" | "bottom" | "suppress";
     altTextSource: "name" | "abbreviation" | "description";
-    secondsPerImage: number | null;
-    isFullWidth: boolean | null;
-    isFullHeight: boolean | null;
 } | {
     component: "image-gallery";
     galleryId: string;

package/dist/index.d.ts

@@ -421,8 +421,11 @@ type WebsiteProperties = {
     status: "development" | "preview" | "production";
     isHeaderDisplayed: boolean;
     headerVariant: "default" | "floating";
+    headerAlignment: "start" | "center" | "end";
+    isHeaderProjectDisplayed: boolean;
     isFooterDisplayed: boolean;
     isSidebarDisplayed: boolean;
+    supportsThemeToggle: boolean;
     searchCollectionUuid: string | null;
     logoUrl: string | null;
 };
@@ -493,15 +496,17 @@ type WebElementComponent = {
     IIIFId: string;
 } | {
     component: "image";
-    variant: "default" | "carousel";
     images: Array<WebImage>;
+    variant: "default" | "carousel";
+    carouselOptions: {
+        secondsPerImage: number | null;
+        isFullWidth: boolean | null;
+        isFullHeight: boolean | null;
+    } | null;
     imageQuality: "high" | "low";
     captionSource: "name" | "abbreviation" | "description";
     captionLayout: "top" | "bottom" | "suppress";
     altTextSource: "name" | "abbreviation" | "description";
-    secondsPerImage: number | null;
-    isFullWidth: boolean | null;
-    isFullHeight: boolean | null;
 } | {
     component: "image-gallery";
     galleryId: string;

package/dist/index.js

@@ -1470,7 +1470,7 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (altTextSource === null) {
         altTextSource = "name";
       }
-      let secondsPerImage = images.length > 1 ? 5 : null;
+      let secondsPerImage = 5;
       const secondsPerImageProperty = getPropertyValueByLabel(
         componentProperty.properties,
         "seconds-per-image"
@@ -1496,13 +1496,15 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       }
       properties.images = images;
       properties.variant = variant;
+      properties.carouselOptions = images.length > 1 ? {
+        secondsPerImage,
+        isFullWidth,
+        isFullHeight
+      } : null;
       properties.imageQuality = imageQuality;
       properties.captionLayout = captionLayout;
       properties.captionSource = captionSource;
       properties.altTextSource = altTextSource;
-      properties.secondsPerImage = secondsPerImage;
-      properties.isFullWidth = isFullWidth;
-      properties.isFullHeight = isFullHeight;
       break;
     }
     case "image-gallery": {
@@ -1889,9 +1891,12 @@ function parseWebsiteProperties(properties) {
   const logoUuid = websiteProperties.find((property) => property.label === "logo")?.values[0]?.uuid ?? null;
   let isHeaderDisplayed = true;
   let headerVariant = "default";
+  let headerAlignment = "start";
+  let isHeaderProjectDisplayed = true;
   let isFooterDisplayed = true;
   let isSidebarDisplayed = false;
   let searchCollectionUuid = null;
+  let supportsThemeToggle = true;
   const headerProperty = websiteProperties.find(
     (property) => property.label === "navbar-visible"
   )?.values[0];
@@ -1904,6 +1909,18 @@ function parseWebsiteProperties(properties) {
   if (headerVariantProperty) {
     headerVariant = headerVariantProperty.content;
   }
+  const headerAlignmentProperty = websiteProperties.find(
+    (property) => property.label === "navbar-alignment"
+  )?.values[0];
+  if (headerAlignmentProperty) {
+    headerAlignment = headerAlignmentProperty.content;
+  }
+  const isHeaderProjectDisplayedProperty = websiteProperties.find(
+    (property) => property.label === "navbar-project-visible"
+  )?.values[0];
+  if (isHeaderProjectDisplayedProperty) {
+    isHeaderProjectDisplayed = isHeaderProjectDisplayedProperty.content === "Yes";
+  }
   const footerProperty = websiteProperties.find(
     (property) => property.label === "footer-visible"
   )?.values[0];
@@ -1922,6 +1939,12 @@ function parseWebsiteProperties(properties) {
   if (collectionSearchProperty) {
     searchCollectionUuid = collectionSearchProperty.uuid;
   }
+  const supportsThemeToggleProperty = websiteProperties.find(
+    (property) => property.label === "supports-theme-toggle"
+  )?.values[0];
+  if (supportsThemeToggleProperty) {
+    supportsThemeToggle = supportsThemeToggleProperty.content === "Yes";
+  }
   const {
     type: validatedType,
     status: validatedStatus,
@@ -1933,8 +1956,11 @@ function parseWebsiteProperties(properties) {
     status: validatedStatus,
     isHeaderDisplayed,
     headerVariant,
+    headerAlignment,
+    isHeaderProjectDisplayed,
     isFooterDisplayed,
     isSidebarDisplayed,
+    supportsThemeToggle,
     searchCollectionUuid,
     logoUrl: logoUuid !== null ? `https://ochre.lib.uchicago.edu/ochre?uuid=${logoUuid}&load` : null
   };

package/package.json

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