@digitalculture/ochre-sdk 0.12.14 → 0.12.16

package/dist/index.d.mts

@@ -559,7 +559,7 @@ type Website = {
     isHeaderProjectDisplayed: boolean;
     isFooterDisplayed: boolean;
     isSidebarDisplayed: boolean;
-    headerSearchBarPageSlug: string | null;
+    headerSearchBarBoundElementUuid: string | null;
     supportsThemeToggle: boolean;
     defaultTheme: "light" | "dark" | null;
     logoUrl: string | null;
@@ -676,6 +676,7 @@ type WebElementComponent = {
 } | {
   component: "collection";
   collectionIds: Array<string>;
+  displayedPropertyUuids: Array<string> | null;
   variant: "full" | "highlights";
   itemVariant: "detailed" | "card" | "tile";
   paginationVariant: "default" | "numeric";
@@ -683,10 +684,11 @@ type WebElementComponent = {
   isSortDisplayed: boolean;
   isFilterDisplayed: boolean;
   filterSort: "default" | "alphabetical";
+  isUsingQueryParams: boolean;
   search: {
-    isUsingQueryParams: boolean;
     isResultsBarDisplayed: boolean;
     isMapDisplayed: boolean;
+    isInputDisplayed: boolean;
   };
   options: {
     attributeFilters: {
@@ -774,9 +776,8 @@ type WebElementComponent = {
   }>;
 } | {
   component: "search-bar";
-  variant: "default" | "full";
   placeholder: string | null;
-  baseQuery: string | null;
+  baseFilterQueries: string | null;
   boundElementUuid: string | null;
   href: string | null;
 } | {

package/dist/index.mjs

@@ -1795,6 +1795,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 		case "collection": {
 			const collectionLinks = links.filter((link) => link.category === "set");
 			if (collectionLinks.length === 0) throw new Error(`Collection links not found for the following component: “${componentName}”`);
+			const displayedProperties = getPropertyByLabel(componentProperty.properties, "use-property");
 			let variant = getPropertyValueByLabel(componentProperty.properties, "variant");
 			variant ??= "full";
 			let itemVariant = getPropertyValueByLabel(componentProperty.properties, "item-variant");
@@ -1804,20 +1805,23 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			let isUsingQueryParams = false;
 			const isUsingQueryParamsProperty = getPropertyValueByLabel(componentProperty.properties, "is-using-query-params");
 			if (isUsingQueryParamsProperty !== null) isUsingQueryParams = isUsingQueryParamsProperty === true;
-			let isResultsBarDisplayed = false;
-			const isResultsBarDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "results-bar-displayed");
-			if (isResultsBarDisplayedProperty !== null) isResultsBarDisplayed = isResultsBarDisplayedProperty === true;
-			let isMapDisplayed = false;
-			const isMapDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "map-displayed");
-			if (isMapDisplayedProperty !== null) isMapDisplayed = isMapDisplayedProperty === true;
+			let isFilterResultsBarDisplayed = false;
+			const isFilterResultsBarDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "filter-results-bar-displayed");
+			if (isFilterResultsBarDisplayedProperty !== null) isFilterResultsBarDisplayed = isFilterResultsBarDisplayedProperty === true;
+			let isFilterMapDisplayed = false;
+			const isFilterMapDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "filter-map-displayed");
+			if (isFilterMapDisplayedProperty !== null) isFilterMapDisplayed = isFilterMapDisplayedProperty === true;
+			let isFilterInputDisplayed = false;
+			const isFilterInputDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "filter-input-displayed");
+			if (isFilterInputDisplayedProperty !== null) isFilterInputDisplayed = isFilterInputDisplayedProperty === true;
 			let isSortDisplayed = false;
 			const isSortDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "sort-displayed");
 			if (isSortDisplayedProperty !== null) isSortDisplayed = isSortDisplayedProperty === true;
-			let isFilterDisplayed = false;
-			const isFilterDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "filter-displayed");
-			if (isFilterDisplayedProperty !== null) isFilterDisplayed = isFilterDisplayedProperty === true;
-			let filterSort = getPropertyValueByLabel(componentProperty.properties, "filter-sort");
-			filterSort ??= "default";
+			let isFilterSidebarDisplayed = false;
+			const isFilterSidebarDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "filter-sidebar-displayed");
+			if (isFilterSidebarDisplayedProperty !== null) isFilterSidebarDisplayed = isFilterSidebarDisplayedProperty === true;
+			let filterSidebarSort = getPropertyValueByLabel(componentProperty.properties, "filter-sidebar-sort");
+			filterSidebarSort ??= "default";
 			let layout = getPropertyValueByLabel(componentProperty.properties, "layout");
 			layout ??= "image-start";
 			const options = {
@@ -1862,17 +1866,19 @@ function parseWebElementProperties(componentProperty, elementResource) {
 				};
 			}
 			properties.collectionIds = collectionLinks.map((link) => link.uuid);
+			properties.displayedPropertyUuids = displayedProperties?.values.map((value) => value.uuid).filter(Boolean) ?? null;
 			properties.variant = variant;
 			properties.itemVariant = itemVariant;
 			properties.paginationVariant = paginationVariant;
-			properties.search = {
-				isUsingQueryParams,
-				isResultsBarDisplayed,
-				isMapDisplayed
+			properties.isUsingQueryParams = isUsingQueryParams;
+			properties.filter = {
+				isSidebarDisplayed: isFilterSidebarDisplayed,
+				isResultsBarDisplayed: isFilterResultsBarDisplayed,
+				isMapDisplayed: isFilterMapDisplayed,
+				isInputDisplayed: isFilterInputDisplayed,
+				sidebarSort: filterSidebarSort
 			};
 			properties.isSortDisplayed = isSortDisplayed;
-			properties.isFilterDisplayed = isFilterDisplayed;
-			properties.filterSort = filterSort;
 			properties.layout = layout;
 			properties.options = options;
 			break;
@@ -2078,13 +2084,10 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			const linkToProperty = getPropertyByLabel(componentProperty.properties, "link-to");
 			const href = linkToProperty?.values[0]?.href ?? linkToProperty?.values[0]?.slug ?? null;
 			if (!boundElementPropertyUuid && !href) throw new Error(`Bound element or href not found for the following component: “${componentName}”`);
-			let variant = getPropertyValueByLabel(componentProperty.properties, "variant");
-			variant ??= "default";
 			const placeholder = getPropertyValueByLabel(componentProperty.properties, "placeholder-text");
-			const baseQuery = getPropertyValueByLabel(componentProperty.properties, "base-query");
-			properties.variant = variant;
+			const baseFilterQueries = getPropertyValueByLabel(componentProperty.properties, "base-filter-queries");
 			properties.placeholder = placeholder !== null ? String(placeholder) : null;
-			properties.baseQuery = baseQuery !== null ? String(baseQuery).replaceAll(String.raw`\{`, "{").replaceAll(String.raw`\}`, "}") : null;
+			properties.baseFilterQueries = baseFilterQueries !== null ? String(baseFilterQueries).replaceAll(String.raw`\{`, "{").replaceAll(String.raw`\}`, "}") : null;
 			properties.boundElementUuid = boundElementPropertyUuid;
 			properties.href = href;
 			break;
@@ -2260,7 +2263,7 @@ function parseWebpage(webpageResource) {
 	let isHeaderSearchBarDisplayed = true;
 	const webpageSubProperties = webpageProperties.find((property) => property.label === "presentation" && property.values[0]?.content === "page")?.properties;
 	if (webpageSubProperties) {
-		const headerProperty = webpageSubProperties.find((property) => property.label === "header")?.values[0];
+		const headerProperty = webpageSubProperties.find((property) => property.label === "displayed-in-navbar")?.values[0];
 		if (headerProperty) displayedInHeader = headerProperty.content === true;
 		const widthProperty = webpageSubProperties.find((property) => property.label === "width")?.values[0];
 		if (widthProperty) width = widthProperty.content;
@@ -2270,7 +2273,7 @@ function parseWebpage(webpageResource) {
 		if (isSidebarDisplayedProperty) isSidebarDisplayed = isSidebarDisplayedProperty.content === true;
 		const isBreadcrumbsDisplayedProperty = webpageSubProperties.find((property) => property.label === "breadcrumbs-displayed")?.values[0];
 		if (isBreadcrumbsDisplayedProperty) isBreadcrumbsDisplayed = isBreadcrumbsDisplayedProperty.content === true;
-		const isHeaderSearchBarDisplayedProperty = webpageSubProperties.find((property) => property.label === "header-search-bar-displayed")?.values[0];
+		const isHeaderSearchBarDisplayedProperty = webpageSubProperties.find((property) => property.label === "navbar-search-bar-displayed")?.values[0];
 		if (isHeaderSearchBarDisplayedProperty) isHeaderSearchBarDisplayed = isHeaderSearchBarDisplayedProperty.content === true;
 	}
 	const cssStyleSubProperties = webpageProperties.find((property) => property.label === "presentation" && property.values[0]?.content === "css")?.properties;
@@ -2651,7 +2654,7 @@ function parseWebsiteProperties(properties, websiteTree) {
 	if (footerProperty) isFooterDisplayed = footerProperty.content === true;
 	const sidebarProperty = websiteProperties.find((property) => property.label === "sidebar-displayed")?.values[0];
 	if (sidebarProperty) isSidebarDisplayed = sidebarProperty.content === true;
-	const headerSearchBarPageSlug = websiteProperties.find((property) => property.label === "navbar-search-bar-page")?.values[0]?.content?.toString() ?? null;
+	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 supportsThemeToggleProperty = websiteProperties.find((property) => property.label === "supports-theme-toggle")?.values[0];
@@ -2700,7 +2703,7 @@ function parseWebsiteProperties(properties, websiteTree) {
 		isHeaderProjectDisplayed,
 		isFooterDisplayed,
 		isSidebarDisplayed,
-		headerSearchBarPageSlug,
+		headerSearchBarBoundElementUuid,
 		supportsThemeToggle,
 		defaultTheme,
 		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.12.14",
+  "version": "0.12.16",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -40,7 +40,7 @@
     "dist"
   ],
   "dependencies": {
-    "zod": "^4.1.12"
+    "zod": "^4.1.13"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^6.2.0",
@@ -49,9 +49,9 @@
     "eslint": "^9.39.1",
     "prettier": "^3.6.2",
     "terser": "^5.44.1",
-    "tsdown": "^0.16.3",
+    "tsdown": "^0.16.7",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.8"
+    "vitest": "^4.0.14"
   },
   "scripts": {
     "dev": "tsdown src/index.ts --watch",