@digitalculture/ochre-sdk 0.2.6 → 0.2.8

package/README.md

@@ -5,19 +5,19 @@ This is the OCHRE JavaScript/TypeScript SDK for interacting with OCHRE (Online C
 ## Installation
 
 ```bash
-pnpm add @digital-culture/ochre-sdk
+pnpm add @digitalculture/ochre-sdk
 ```
 
 or
 
 ```bash
-npm install @digital-culture/ochre-sdk
+npm install @digitalculture/ochre-sdk
 ```
 
 or
 
 ```bash
-bun add @digital-culture/ochre-sdk
+bun add @digitalculture/ochre-sdk
 ```
 
 ## Start development server

package/dist/index.cjs

@@ -898,7 +898,7 @@ function parseProperties(properties, language = "eng") {
   for (const property of properties) {
     const valuesToParse = "value" in property && property.value ? Array.isArray(property.value) ? property.value : [property.value] : [];
     const values = valuesToParse.map(
-      (value) => !["string", "number", "boolean"].includes(typeof value) && typeof value === "object" && "uuid" in value ? {
+      (value) => !["string", "number", "boolean"].includes(typeof value) && typeof value === "object" ? {
         content: parseStringContent(value),
         type: value.type,
         category: value.category !== "value" ? value.category ?? null : null,
@@ -1513,6 +1513,13 @@ async function parseWebElementProperties(componentProperty, elementResource) {
           height: imageLink.image?.height ?? 0
         });
       }
+      let variant = getPropertyValueByLabel(
+        componentProperty.properties,
+        "variant"
+      );
+      if (variant === null) {
+        variant = "default";
+      }
       let captionLayout = getPropertyValueByLabel(
         componentProperty.properties,
         "caption-layout"
@@ -1541,40 +1548,39 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (altTextSource === null) {
         altTextSource = "name";
       }
-      const carousel = images.length > 1 ? {
-        secondsPerImage: 5,
-        isFullWidth: false,
-        isFullHeight: false
-      } : null;
-      if (carousel !== null) {
-        const carouselSecondsPerImage = getPropertyValueByLabel(
-          componentProperty.properties,
-          "carousel-seconds-per-image"
-        );
-        if (carouselSecondsPerImage !== null) {
-          carousel.secondsPerImage = Number.parseFloat(carouselSecondsPerImage);
-        }
-        const carouselIsFullWidth = getPropertyValueByLabel(
-          componentProperty.properties,
-          "carousel-full-width"
-        );
-        if (carouselIsFullWidth !== null) {
-          carousel.isFullWidth = carouselIsFullWidth === "Yes";
-        }
-        const carouselIsFullHeight = getPropertyValueByLabel(
-          componentProperty.properties,
-          "carousel-full-height"
-        );
-        if (carouselIsFullHeight !== null) {
-          carousel.isFullHeight = carouselIsFullHeight === "Yes";
-        }
+      let secondsPerImage = images.length > 1 ? 5 : null;
+      const secondsPerImageProperty = getPropertyValueByLabel(
+        componentProperty.properties,
+        "seconds-per-image"
+      );
+      if (secondsPerImageProperty !== null) {
+        secondsPerImage = Number.parseFloat(secondsPerImageProperty);
+      }
+      let isFullWidth = false;
+      const isFullWidthProperty = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-full-width"
+      );
+      if (isFullWidthProperty !== null) {
+        isFullWidth = isFullWidthProperty === "Yes";
+      }
+      let isFullHeight = false;
+      const isFullHeightProperty = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-full-height"
+      );
+      if (isFullHeightProperty !== null) {
+        isFullHeight = isFullHeightProperty === "Yes";
       }
       properties.images = images;
+      properties.variant = variant;
       properties.imageQuality = imageQuality;
       properties.captionLayout = captionLayout;
       properties.captionSource = captionSource;
       properties.altTextSource = altTextSource;
-      properties.carousel = carousel;
+      properties.secondsPerImage = secondsPerImage;
+      properties.isFullWidth = isFullWidth;
+      properties.isFullHeight = isFullHeight;
       break;
     }
     case "image-gallery": {

package/dist/index.d.cts

@@ -499,11 +499,9 @@ type WebElementComponent = {
     captionSource: "name" | "abbreviation" | "description";
     captionLayout: "top" | "bottom" | "suppress";
     altTextSource: "name" | "abbreviation" | "description";
-    carousel: {
-        secondsPerImage: number;
-        isFullWidth: boolean;
-        isFullHeight: boolean;
-    } | null;
+    secondsPerImage: number | null;
+    isFullWidth: boolean | null;
+    isFullHeight: boolean | null;
 } | {
     component: "image-gallery";
     galleryId: string;

package/dist/index.d.ts

@@ -499,11 +499,9 @@ type WebElementComponent = {
     captionSource: "name" | "abbreviation" | "description";
     captionLayout: "top" | "bottom" | "suppress";
     altTextSource: "name" | "abbreviation" | "description";
-    carousel: {
-        secondsPerImage: number;
-        isFullWidth: boolean;
-        isFullHeight: boolean;
-    } | null;
+    secondsPerImage: number | null;
+    isFullWidth: boolean | null;
+    isFullHeight: boolean | null;
 } | {
     component: "image-gallery";
     galleryId: string;

package/dist/index.js

@@ -820,7 +820,7 @@ function parseProperties(properties, language = "eng") {
   for (const property of properties) {
     const valuesToParse = "value" in property && property.value ? Array.isArray(property.value) ? property.value : [property.value] : [];
     const values = valuesToParse.map(
-      (value) => !["string", "number", "boolean"].includes(typeof value) && typeof value === "object" && "uuid" in value ? {
+      (value) => !["string", "number", "boolean"].includes(typeof value) && typeof value === "object" ? {
         content: parseStringContent(value),
         type: value.type,
         category: value.category !== "value" ? value.category ?? null : null,
@@ -1435,6 +1435,13 @@ async function parseWebElementProperties(componentProperty, elementResource) {
           height: imageLink.image?.height ?? 0
         });
       }
+      let variant = getPropertyValueByLabel(
+        componentProperty.properties,
+        "variant"
+      );
+      if (variant === null) {
+        variant = "default";
+      }
       let captionLayout = getPropertyValueByLabel(
         componentProperty.properties,
         "caption-layout"
@@ -1463,40 +1470,39 @@ async function parseWebElementProperties(componentProperty, elementResource) {
       if (altTextSource === null) {
         altTextSource = "name";
       }
-      const carousel = images.length > 1 ? {
-        secondsPerImage: 5,
-        isFullWidth: false,
-        isFullHeight: false
-      } : null;
-      if (carousel !== null) {
-        const carouselSecondsPerImage = getPropertyValueByLabel(
-          componentProperty.properties,
-          "carousel-seconds-per-image"
-        );
-        if (carouselSecondsPerImage !== null) {
-          carousel.secondsPerImage = Number.parseFloat(carouselSecondsPerImage);
-        }
-        const carouselIsFullWidth = getPropertyValueByLabel(
-          componentProperty.properties,
-          "carousel-full-width"
-        );
-        if (carouselIsFullWidth !== null) {
-          carousel.isFullWidth = carouselIsFullWidth === "Yes";
-        }
-        const carouselIsFullHeight = getPropertyValueByLabel(
-          componentProperty.properties,
-          "carousel-full-height"
-        );
-        if (carouselIsFullHeight !== null) {
-          carousel.isFullHeight = carouselIsFullHeight === "Yes";
-        }
+      let secondsPerImage = images.length > 1 ? 5 : null;
+      const secondsPerImageProperty = getPropertyValueByLabel(
+        componentProperty.properties,
+        "seconds-per-image"
+      );
+      if (secondsPerImageProperty !== null) {
+        secondsPerImage = Number.parseFloat(secondsPerImageProperty);
+      }
+      let isFullWidth = false;
+      const isFullWidthProperty = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-full-width"
+      );
+      if (isFullWidthProperty !== null) {
+        isFullWidth = isFullWidthProperty === "Yes";
+      }
+      let isFullHeight = false;
+      const isFullHeightProperty = getPropertyValueByLabel(
+        componentProperty.properties,
+        "is-full-height"
+      );
+      if (isFullHeightProperty !== null) {
+        isFullHeight = isFullHeightProperty === "Yes";
       }
       properties.images = images;
+      properties.variant = variant;
       properties.imageQuality = imageQuality;
       properties.captionLayout = captionLayout;
       properties.captionSource = captionSource;
       properties.altTextSource = altTextSource;
-      properties.carousel = carousel;
+      properties.secondsPerImage = secondsPerImage;
+      properties.isFullWidth = isFullWidth;
+      properties.isFullHeight = isFullHeight;
       break;
     }
     case "image-gallery": {

package/package.json

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