ochre-sdk 1.0.51 → 1.0.53

package/dist/parsers/website/index.mjs

@@ -233,6 +233,60 @@ function parseStylesheets(styles) {
 	return parsedStyles;
 }
 /**
+* Default values for a collection's display properties, shared between the
+* "collection" component and the "query" component's collection overrides.
+*/
+const COLLECTION_PROPERTY_DEFAULTS = {
+	variant: "slide",
+	paginationVariant: "default",
+	loadingVariant: "skeleton",
+	imageLayout: "start",
+	isImagePlaceholderDisplayed: true,
+	minimumColumnCount: null,
+	maximumColumnCount: null,
+	expectedItemCount: null,
+	isSortDisplayed: false,
+	isUsingQueryParams: false,
+	isInteractive: true
+};
+/**
+* Reads the collection display properties explicitly set on a reader, omitting
+* any that are unset. The "collection" component merges these over
+* {@link COLLECTION_PROPERTY_DEFAULTS}, while the "query" component uses them as
+* partial overrides for its embedded collection.
+*/
+function parseCollectionPropertyOverrides(reader) {
+	const overrides = {};
+	function read(key, label) {
+		const value = reader.value(label);
+		if (value != null) overrides[key] = value;
+	}
+	read("variant", "variant");
+	read("paginationVariant", "pagination-variant");
+	read("loadingVariant", "loading-variant");
+	read("imageLayout", "image-layout");
+	read("isImagePlaceholderDisplayed", "image-placeholder-displayed");
+	read("minimumColumnCount", "minimum-column-count");
+	read("maximumColumnCount", "maximum-column-count");
+	read("expectedItemCount", "item-count");
+	read("isSortDisplayed", "sort-displayed");
+	read("isUsingQueryParams", "is-using-query-params");
+	read("isInteractive", "is-interactive");
+	return overrides;
+}
+/**
+* Parses the "use-property" values defining which item properties a collection
+* displays, returning `null` when none are set.
+*/
+function parseCollectionDisplayedProperties(reader) {
+	const property = reader.property("use-property");
+	if (property == null) return null;
+	return property.values.filter((value) => value.uuid !== null).map((value) => ({
+		uuid: value.uuid,
+		label: value.label
+	}));
+}
+/**
 * Parses raw web element properties into a standardized WebElementComponent structure
 *
 * @param componentProperty - Raw component property data in OCHRE format
@@ -352,6 +406,14 @@ function parseWebElementProperties(componentProperty, elementResource, options,
 				description: imageLink.description,
 				quality: "high"
 			};
+			const childResources = elementResource.resource ? normalizeWebsiteResources(elementResource.resource) : [];
+			const elements = [];
+			for (const childResource of childResources) {
+				const childReader = websitePresentationReader(childResource.properties ? parseSimplifiedProperties(childResource.properties, options) : []);
+				if (childReader.value("presentation") !== "element") continue;
+				if (childReader.nestedByValue("presentation", "element").value("component") === "button") continue;
+				elements.push(parseWebElement(childResource, options, context));
+			}
 			properties = {
 				component: "button",
 				variant,
@@ -361,46 +423,27 @@ function parseWebElementProperties(componentProperty, elementResource, options,
 				label: elementResource.document && "content" in elementResource.document ? parseXMLContent(elementResource.document, options) : null,
 				startIcon,
 				endIcon,
-				image
+				image,
+				elements
 			};
 			break;
 		}
 		case "collection": {
 			const setLinks = getWebsiteLinks(websiteLinks, "set");
 			if (setLinks.length === 0) throw new Error(formatComponentError("Set links not found", componentName, elementResource), { cause: componentProperty });
-			const displayedProperties = componentReader.property("use-property");
-			const variant = componentReader.valueOr("variant", "slide");
-			const paginationVariant = componentReader.valueOr("pagination-variant", "default");
-			const loadingVariant = componentReader.valueOr("loading-variant", "skeleton");
-			const expectedItemCount = componentReader.valueOr("item-count", null);
-			const isUsingQueryParams = componentReader.valueOr("is-using-query-params", false);
 			const isFilterResultsBarDisplayed = componentReader.valueOr("filter-results-bar-displayed", false);
 			const isFilterInputDisplayed = componentReader.valueOr("filter-input-displayed", false);
 			const isFilterLimitedToInputFilter = componentReader.valueOr("filter-limit-to-input-filter", false);
 			const isFilterLimitedToLeafPropertyValues = componentReader.valueOr("filter-limit-to-leaf-property-values", false);
-			const isSortDisplayed = componentReader.valueOr("sort-displayed", false);
 			const isFilterSidebarDisplayed = componentReader.valueOr("filter-sidebar-displayed", false);
 			const filterSidebarSort = componentReader.valueOr("filter-sidebar-sort", "default");
-			const imageLayout = componentReader.valueOr("image-layout", "start");
-			const isImagePlaceholderDisplayed = componentReader.valueOr("image-placeholder-displayed", true);
-			const isInteractive = componentReader.valueOr("is-interactive", true);
 			const componentOptions = parseWebsiteOptions(elementResource.options, options);
 			properties = {
 				component: "collection",
 				linkUuids: setLinks.map((link) => link.uuid),
-				displayedProperties: displayedProperties?.values.filter(({ uuid }) => uuid !== null).map((value) => ({
-					uuid: value.uuid,
-					label: value.label
-				})) ?? null,
-				variant,
-				paginationVariant,
-				loadingVariant,
-				imageLayout,
-				isImagePlaceholderDisplayed,
-				expectedItemCount,
-				isSortDisplayed,
-				isUsingQueryParams,
-				isInteractive,
+				displayedProperties: parseCollectionDisplayedProperties(componentReader),
+				...COLLECTION_PROPERTY_DEFAULTS,
+				...parseCollectionPropertyOverrides(componentReader),
 				filter: {
 					isSidebarDisplayed: isFilterSidebarDisplayed,
 					isResultsBarDisplayed: isFilterResultsBarDisplayed,
@@ -601,31 +644,9 @@ function parseWebElementProperties(componentProperty, elementResource, options,
 			}
 			if (items.length === 0) throw new Error(formatComponentError("No queries found", componentName, elementResource), { cause: componentProperty });
 			const componentOptions = parseWebsiteOptions(elementResource.options, options);
-			const collectionProperties = {};
-			const displayedProperties = componentReader.property("use-property");
-			if (displayedProperties != null) collectionProperties.displayedProperties = displayedProperties.values.filter((value) => value.uuid !== null).map((value) => ({
-				uuid: value.uuid,
-				label: value.label
-			}));
-			const overrideReader = componentReader.nestedByValue("sub-component-override", "collection");
-			const variant = overrideReader.value("variant");
-			if (variant != null) collectionProperties.variant = variant;
-			const paginationVariant = overrideReader.value("pagination-variant");
-			if (paginationVariant != null) collectionProperties.paginationVariant = paginationVariant;
-			const loadingVariant = overrideReader.value("loading-variant");
-			if (loadingVariant != null) collectionProperties.loadingVariant = loadingVariant;
-			const imageLayout = overrideReader.value("image-layout");
-			if (imageLayout != null) collectionProperties.imageLayout = imageLayout;
-			const isImagePlaceholderDisplayed = overrideReader.value("image-placeholder-displayed");
-			if (isImagePlaceholderDisplayed != null) collectionProperties.isImagePlaceholderDisplayed = isImagePlaceholderDisplayed;
-			const expectedItemCount = overrideReader.value("item-count");
-			if (expectedItemCount != null) collectionProperties.expectedItemCount = expectedItemCount;
-			const isSortDisplayed = overrideReader.value("sort-displayed");
-			if (isSortDisplayed != null) collectionProperties.isSortDisplayed = isSortDisplayed;
-			const isUsingQueryParams = overrideReader.value("is-using-query-params");
-			if (isUsingQueryParams != null) collectionProperties.isUsingQueryParams = isUsingQueryParams;
-			const isInteractive = overrideReader.value("is-interactive");
-			if (isInteractive != null) collectionProperties.isInteractive = isInteractive;
+			const collectionProperties = parseCollectionPropertyOverrides(componentReader.nestedByValue("sub-component-override", "collection"));
+			const displayedProperties = parseCollectionDisplayedProperties(componentReader);
+			if (displayedProperties != null) collectionProperties.displayedProperties = displayedProperties;
 			properties = {
 				component: "query",
 				linkUuids: setLinks.map((link) => link.uuid),

package/dist/types/website.d.mts

@@ -290,6 +290,7 @@ type WebElementComponent<T extends LanguageCodes = LanguageCodes> = {
   startIcon: string | null;
   endIcon: string | null;
   image: WebImage<T> | null;
+  elements: Array<WebElement<T>>;
 } | {
   component: "collection";
   linkUuids: Array<string>;
@@ -302,6 +303,8 @@ type WebElementComponent<T extends LanguageCodes = LanguageCodes> = {
   loadingVariant: "spinner" | "skeleton" | "animation" | "none";
   imageLayout: "top" | "bottom" | "start" | "end" | null;
   isImagePlaceholderDisplayed: boolean;
+  minimumColumnCount: number | null;
+  maximumColumnCount: number | null;
   expectedItemCount: number | null;
   isSortDisplayed: boolean;
   isUsingQueryParams: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "1.0.51",
+  "version": "1.0.53",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -47,7 +47,7 @@
   "dependencies": {
     "date-fns": "^4.4.0",
     "fast-equals": "^6.0.0",
-    "fast-xml-parser": "^5.8.0",
+    "fast-xml-parser": "^5.9.2",
     "valibot": "^1.4.1"
   },
   "devDependencies": {
@@ -55,11 +55,11 @@
     "@types/node": "^24.13.2",
     "bumpp": "^11.1.0",
     "eslint": "^10.5.0",
-    "knip": "^6.16.1",
-    "oxfmt": "^0.54.0",
-    "tsdown": "^0.22.2",
+    "knip": "^6.17.1",
+    "oxfmt": "^0.55.0",
+    "tsdown": "^0.22.3",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.8"
+    "vitest": "^4.1.9"
   },
   "scripts": {
     "dev": "tsdown src/index.ts --watch",