@digitalculture/ochre-sdk 0.14.6 → 0.14.8

package/dist/index.d.mts

@@ -162,7 +162,7 @@ type Link = {
 type ImageMapArea = {
   uuid: string;
   publicationDateTime: Date | null;
-  type: string;
+  category: string;
   title: string;
   shape: "rectangle" | "circle" | "polygon";
   coords: Array<number>;
@@ -446,6 +446,9 @@ type PropertyValueContent<T extends PropertyValueContentType> = {
   label: string | null;
   isUncertain: boolean;
   unit: string | null;
+  height: number | null;
+  width: number | null;
+  fileSize: number | null;
   category: string | null;
   type: string | null;
   uuid: string | null;
@@ -631,6 +634,7 @@ type Website = {
     logoUrl: string | null;
     itemPage: {
       iiifViewer: "universal-viewer" | "clover";
+      isPropertyValuesGrouped: boolean;
       options: {
         contexts: PropertyContexts;
       };
@@ -747,6 +751,7 @@ type WebElementComponent = {
   itemVariant: "detailed" | "card" | "tile";
   paginationVariant: "default" | "numeric";
   layout: "image-top" | "image-bottom" | "image-start" | "image-end";
+  imageQuality: "high" | "low";
   isSortDisplayed: boolean;
   isUsingQueryParams: boolean;
   filter: {
@@ -811,6 +816,8 @@ type WebElementComponent = {
   component: "map";
   mapId: string;
   customBasemap: string | null;
+  initialBounds: [[number, number], [number, number]] | null;
+  maximumBounds: [[number, number], [number, number]] | null;
   isControlsDisplayed: boolean;
   isInteractive: boolean;
   isClustered: boolean;

package/dist/index.mjs

@@ -151,6 +151,32 @@ const whitespaceSchema = z.string().transform((str) => str.split(" ")).pipe(z.ar
 * @internal
 */
 const emailSchema = z.email({ error: "Invalid email" });
+/**
+* Schema for parsing and validating a string in the format "[[number, number], [number, number]]"
+* into an array with exactly two bounds
+* @internal
+*/
+const boundsSchema = z.string().transform((str, ctx) => {
+	const trimmed = str.trim();
+	if (!trimmed.startsWith("[[") || !trimmed.endsWith("]]")) {
+		ctx.addIssue({
+			code: "invalid_format",
+			format: "string",
+			message: "String must start with '[[' and end with ']]'"
+		});
+		return z.NEVER;
+	}
+	try {
+		return JSON.parse(trimmed);
+	} catch {
+		ctx.addIssue({
+			code: "invalid_format",
+			format: "string",
+			message: "Invalid JSON format"
+		});
+		return z.NEVER;
+	}
+}).pipe(z.tuple([z.tuple([z.number(), z.number()]), z.tuple([z.number(), z.number()])], { message: "Must contain exactly 2 coordinate pairs" }));
 
 //#endregion
 //#region src/utils/getters.ts
@@ -1179,6 +1205,9 @@ function parseProperty(property, language = "eng") {
 				uuid: null,
 				publicationDateTime: null,
 				unit: null,
+				height: null,
+				width: null,
+				fileSize: null,
 				href: null,
 				slug: null
 			};
@@ -1231,6 +1260,9 @@ function parseProperty(property, language = "eng") {
 				uuid: value.uuid ?? null,
 				publicationDateTime: value.publicationDateTime != null ? new Date(value.publicationDateTime) : null,
 				unit: value.unit ?? null,
+				height: value.height ?? null,
+				width: value.width ?? null,
+				fileSize: value.fileSize ?? null,
 				href: value.href ?? null,
 				slug: value.slug ?? null
 			};
@@ -1289,7 +1321,7 @@ function parseImageMap(imageMap) {
 	for (const area of imageMapAreasToParse) returnImageMap.area.push({
 		uuid: area.uuid,
 		publicationDateTime: area.publicationDateTime != null ? new Date(area.publicationDateTime) : null,
-		type: area.type,
+		category: area.type,
 		title: parseFakeString(area.title),
 		shape: area.shape === "rect" ? "rectangle" : area.shape === "circle" ? "circle" : "polygon",
 		coords: area.coords.split(",").map((coord) => Number.parseInt(coord)),
@@ -1816,6 +1848,11 @@ function parseConcepts(concepts) {
 	for (const concept of conceptsToParse) returnConcepts.push(parseConcept(concept));
 	return returnConcepts;
 }
+function parseBounds(bounds) {
+	const result = boundsSchema.safeParse(bounds);
+	if (!result.success) throw new Error(`Invalid bounds: ${result.error.message}`);
+	return result.data;
+}
 /**
 * Parses raw web element properties into a standardized WebElementComponent structure
 *
@@ -1953,6 +1990,8 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			itemVariant ??= "detailed";
 			let paginationVariant = getPropertyValueByLabel(componentProperty.properties, "pagination-variant");
 			paginationVariant ??= "default";
+			let imageQuality = getPropertyValueByLabel(componentProperty.properties, "image-quality");
+			imageQuality ??= "low";
 			let isUsingQueryParams = false;
 			const isUsingQueryParamsProperty = getPropertyValueByLabel(componentProperty.properties, "is-using-query-params");
 			if (isUsingQueryParamsProperty !== null) isUsingQueryParams = isUsingQueryParamsProperty === true;
@@ -2024,6 +2063,8 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			properties.variant = variant;
 			properties.itemVariant = itemVariant;
 			properties.paginationVariant = paginationVariant;
+			properties.layout = layout;
+			properties.imageQuality = imageQuality;
 			properties.isUsingQueryParams = isUsingQueryParams;
 			properties.filter = {
 				isSidebarDisplayed: isFilterSidebarDisplayed,
@@ -2033,7 +2074,6 @@ function parseWebElementProperties(componentProperty, elementResource) {
 				sidebarSort: filterSidebarSort
 			};
 			properties.isSortDisplayed = isSortDisplayed;
-			properties.layout = layout;
 			properties.options = options;
 			break;
 		}
@@ -2078,7 +2118,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 		}
 		case "image": {
 			if (links.length === 0) throw new Error(`No links found for the following component: “${componentName}”`);
-			let imageQuality = getPropertyValueByLabel(componentProperty.properties, "quality");
+			let imageQuality = getPropertyValueByLabel(componentProperty.properties, "image-quality");
 			imageQuality ??= "high";
 			const images = [];
 			for (const link of links) images.push({
@@ -2184,6 +2224,12 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			let customBasemap = null;
 			const customBasemapProperty = getPropertyValueByLabel(componentProperty.properties, "custom-basemap");
 			if (customBasemapProperty !== null) customBasemap = customBasemapProperty;
+			let initialBounds = null;
+			const initialBoundsProperty = getPropertyValueByLabel(componentProperty.properties, "initial-bounds");
+			if (initialBoundsProperty !== null) initialBounds = parseBounds(String(initialBoundsProperty));
+			let maximumBounds = null;
+			const maximumBoundsProperty = getPropertyValueByLabel(componentProperty.properties, "maximum-bounds");
+			if (maximumBoundsProperty !== null) maximumBounds = parseBounds(String(maximumBoundsProperty));
 			let isControlsDisplayed = false;
 			const isControlsDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "controls-displayed");
 			if (isControlsDisplayedProperty !== null) isControlsDisplayed = isControlsDisplayedProperty === true;
@@ -2191,10 +2237,12 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			const isFullHeightProperty = getPropertyValueByLabel(componentProperty.properties, "is-full-height");
 			if (isFullHeightProperty !== null) isFullHeight = isFullHeightProperty === true;
 			properties.mapId = mapLink.uuid;
+			properties.customBasemap = customBasemap;
+			properties.initialBounds = initialBounds;
+			properties.maximumBounds = maximumBounds;
 			properties.isInteractive = isInteractive;
 			properties.isClustered = isClustered;
 			properties.isUsingPins = isUsingPins;
-			properties.customBasemap = customBasemap;
 			properties.isControlsDisplayed = isControlsDisplayed;
 			properties.isFullHeight = isFullHeight;
 			break;
@@ -2794,6 +2842,7 @@ function parseWebsiteProperties(properties, websiteTree) {
 	let isFooterDisplayed = true;
 	let isSidebarDisplayed = false;
 	let iiifViewer = "universal-viewer";
+	let isPropertyValuesGrouped = true;
 	let supportsThemeToggle = true;
 	let defaultTheme = null;
 	const headerProperty = websiteProperties.find((property) => property.label === "navbar-displayed")?.values[0];
@@ -2811,6 +2860,8 @@ function parseWebsiteProperties(properties, websiteTree) {
 	const headerSearchBarBoundElementUuid = websiteProperties.find((property) => property.label === "bound-element-navbar-search-bar")?.values[0]?.uuid ?? null;
 	const iiifViewerProperty = websiteProperties.find((property) => property.label === "iiif-viewer")?.values[0];
 	if (iiifViewerProperty) iiifViewer = iiifViewerProperty.content;
+	const isPropertyValuesGroupedProperty = websiteProperties.find((property) => property.label === "is-property-values-grouped")?.values[0];
+	if (isPropertyValuesGroupedProperty) isPropertyValuesGrouped = isPropertyValuesGroupedProperty.content === true;
 	const supportsThemeToggleProperty = websiteProperties.find((property) => property.label === "supports-theme-toggle")?.values[0];
 	if (supportsThemeToggleProperty) supportsThemeToggle = supportsThemeToggleProperty.content === true;
 	const defaultThemeProperty = websiteProperties.find((property) => property.label === "default-theme")?.values[0];
@@ -2863,6 +2914,7 @@ function parseWebsiteProperties(properties, websiteTree) {
 		logoUrl: logoUuid !== null ? `https://ochre.lib.uchicago.edu/ochre?uuid=${logoUuid}&load` : null,
 		itemPage: {
 			iiifViewer,
+			isPropertyValuesGrouped,
 			options: { contexts }
 		}
 	};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.14.6",
+  "version": "0.14.8",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -43,13 +43,13 @@
     "zod": "^4.2.1"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^6.7.1",
+    "@antfu/eslint-config": "^6.7.3",
     "@types/node": "^24.10.4",
     "bumpp": "^10.3.2",
     "eslint": "^9.39.2",
     "prettier": "^3.7.4",
     "terser": "^5.44.1",
-    "tsdown": "^0.18.1",
+    "tsdown": "^0.18.2",
     "typescript": "^5.9.3",
     "vitest": "^4.0.16"
   },