@digitalculture/ochre-sdk 0.12.10 → 0.12.12

package/dist/index.d.mts

@@ -559,36 +559,39 @@ type Website = {
     isHeaderProjectDisplayed: boolean;
     isFooterDisplayed: boolean;
     isSidebarDisplayed: boolean;
-    headerSearchButtonPageSlug: string | null;
+    headerSearchBarPageSlug: string | null;
     iiifViewer: "universal-viewer" | "clover";
     supportsThemeToggle: boolean;
     defaultTheme: "light" | "dark" | null;
     logoUrl: string | null;
   };
 };
+/**
+ * Represents a webpage with its title, slug, properties, items and subpages
+ */
 type Webpage = {
   title: string;
   slug: string;
-  properties: WebpageProperties;
+  properties: {
+    displayedInHeader: boolean;
+    width: "full" | "large" | "narrow" | "default";
+    variant: "default" | "no-background";
+    backgroundImageUrl: string | null;
+    isBreadcrumbsDisplayed: boolean;
+    isSidebarDisplayed: boolean;
+    isHeaderSearchBarDisplayed: boolean;
+    cssStyles: {
+      default: Array<Style>;
+      tablet: Array<Style>;
+      mobile: Array<Style>;
+    };
+  };
   items: Array<WebElement | WebBlock>;
   webpages: Array<Webpage>;
 };
 /**
- * Properties for configuring webpage display and styling
+ * Represents a title with its label and variant
  */
-type WebpageProperties = {
-  displayedInHeader: boolean;
-  width: "full" | "large" | "narrow" | "default";
-  variant: "default" | "no-background";
-  backgroundImageUrl: string | null;
-  isBreadcrumbsDisplayed: boolean;
-  isSidebarDisplayed: boolean;
-  cssStyles: {
-    default: Array<Style>;
-    tablet: Array<Style>;
-    mobile: Array<Style>;
-  };
-};
 type WebTitle = {
   label: string;
   variant: "default" | "simple";
@@ -662,11 +665,15 @@ type WebElementComponent = {
   variant: "full" | "highlights";
   itemVariant: "detailed" | "card" | "tile";
   paginationVariant: "default" | "numeric";
-  isSearchDisplayed: boolean;
+  layout: "image-top" | "image-bottom" | "image-start" | "image-end";
   isSortDisplayed: boolean;
   isFilterDisplayed: boolean;
   filterSort: "default" | "alphabetical";
-  layout: "image-top" | "image-bottom" | "image-start" | "image-end";
+  search: {
+    isInputDisplayed: boolean;
+    isResultsBarDisplayed: boolean;
+    isMapDisplayed: boolean;
+  };
   options: {
     attributeFilters: {
       bibliographies: boolean;
@@ -1200,4 +1207,4 @@ declare function filterProperties(property: Property, filter: {
   value: string | number | boolean | Date;
 }, options?: PropertyOptions): boolean;
 //#endregion
-export { Bibliography, Concept, Context, ContextItem, ContextNode, Coordinates, CoordinatesItem, Data, DataCategory, Event, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyQueryItem, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Set, SpatialUnit, Style, Tree, UuidMetadata, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebTitle, Webpage, WebpageProperties, Website, fetchByUuidMetadata, fetchGallery, fetchItem, fetchPropertyQuery, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { Bibliography, Concept, Context, ContextItem, ContextNode, Coordinates, CoordinatesItem, Data, DataCategory, Event, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyQueryItem, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Set, SpatialUnit, Style, Tree, UuidMetadata, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebTitle, Webpage, Website, fetchByUuidMetadata, fetchGallery, fetchItem, fetchPropertyQuery, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/dist/index.mjs

@@ -1801,9 +1801,15 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			itemVariant ??= "detailed";
 			let paginationVariant = getPropertyValueByLabel(componentProperty.properties, "pagination-variant");
 			paginationVariant ??= "default";
-			let isSearchDisplayed = false;
-			const isSearchDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "search-displayed");
-			if (isSearchDisplayedProperty !== null) isSearchDisplayed = isSearchDisplayedProperty === true;
+			let isInputDisplayed = false;
+			const isInputDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "input-displayed");
+			if (isInputDisplayedProperty !== null) isInputDisplayed = isInputDisplayedProperty === 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 isSortDisplayed = false;
 			const isSortDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "sort-displayed");
 			if (isSortDisplayedProperty !== null) isSortDisplayed = isSortDisplayedProperty === true;
@@ -1859,7 +1865,11 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			properties.variant = variant;
 			properties.itemVariant = itemVariant;
 			properties.paginationVariant = paginationVariant;
-			properties.isSearchDisplayed = isSearchDisplayed;
+			properties.search = {
+				isInputDisplayed,
+				isResultsBarDisplayed,
+				isMapDisplayed
+			};
 			properties.isSortDisplayed = isSortDisplayed;
 			properties.isFilterDisplayed = isFilterDisplayed;
 			properties.filterSort = filterSort;
@@ -2247,6 +2257,7 @@ function parseWebpage(webpageResource) {
 	let variant = "default";
 	let isSidebarDisplayed = true;
 	let isBreadcrumbsDisplayed = false;
+	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];
@@ -2255,10 +2266,12 @@ function parseWebpage(webpageResource) {
 		if (widthProperty) width = widthProperty.content;
 		const variantProperty = webpageSubProperties.find((property) => property.label === "variant")?.values[0];
 		if (variantProperty) variant = variantProperty.content;
-		const isSidebarDisplayedProperty = webpageSubProperties.find((property) => property.label === "sidebar-visible")?.values[0];
+		const isSidebarDisplayedProperty = webpageSubProperties.find((property) => property.label === "sidebar-displayed")?.values[0];
 		if (isSidebarDisplayedProperty) isSidebarDisplayed = isSidebarDisplayedProperty.content === true;
-		const isBreadcrumbsDisplayedProperty = webpageSubProperties.find((property) => property.label === "breadcrumbs-visible")?.values[0];
+		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];
+		if (isHeaderSearchBarDisplayedProperty) isHeaderSearchBarDisplayed = isHeaderSearchBarDisplayedProperty.content === true;
 	}
 	const cssStyleSubProperties = webpageProperties.find((property) => property.label === "presentation" && property.values[0]?.content === "css")?.properties;
 	const cssStyles = [];
@@ -2289,6 +2302,7 @@ function parseWebpage(webpageResource) {
 			backgroundImageUrl: imageLink ? `https://ochre.lib.uchicago.edu/ochre?uuid=${imageLink.uuid}&load` : null,
 			isSidebarDisplayed,
 			isBreadcrumbsDisplayed,
+			isHeaderSearchBarDisplayed,
 			cssStyles: {
 				default: cssStyles,
 				tablet: cssStylesTablet,
@@ -2625,19 +2639,19 @@ function parseWebsiteProperties(properties) {
 	let iiifViewer = "universal-viewer";
 	let supportsThemeToggle = true;
 	let defaultTheme = null;
-	const headerProperty = websiteProperties.find((property) => property.label === "navbar-visible")?.values[0];
+	const headerProperty = websiteProperties.find((property) => property.label === "navbar-displayed")?.values[0];
 	if (headerProperty) isHeaderDisplayed = headerProperty.content === true;
 	const headerVariantProperty = websiteProperties.find((property) => property.label === "navbar-variant")?.values[0];
 	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];
+	const isHeaderProjectDisplayedProperty = websiteProperties.find((property) => property.label === "navbar-project-displayed")?.values[0];
 	if (isHeaderProjectDisplayedProperty) isHeaderProjectDisplayed = isHeaderProjectDisplayedProperty.content === true;
-	const footerProperty = websiteProperties.find((property) => property.label === "footer-visible")?.values[0];
+	const footerProperty = websiteProperties.find((property) => property.label === "footer-displayed")?.values[0];
 	if (footerProperty) isFooterDisplayed = footerProperty.content === true;
-	const sidebarProperty = websiteProperties.find((property) => property.label === "sidebar-visible")?.values[0];
+	const sidebarProperty = websiteProperties.find((property) => property.label === "sidebar-displayed")?.values[0];
 	if (sidebarProperty) isSidebarDisplayed = sidebarProperty.content === true;
-	const headerSearchButtonPageSlug = websiteProperties.find((property) => property.label === "navbar-search-button-page")?.values[0]?.content?.toString() ?? null;
+	const headerSearchBarPageSlug = websiteProperties.find((property) => property.label === "navbar-search-bar-page")?.values[0]?.content?.toString() ?? 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];
@@ -2656,7 +2670,7 @@ function parseWebsiteProperties(properties) {
 		isHeaderProjectDisplayed,
 		isFooterDisplayed,
 		isSidebarDisplayed,
-		headerSearchButtonPageSlug,
+		headerSearchBarPageSlug,
 		iiifViewer,
 		supportsThemeToggle,
 		defaultTheme,

package/package.json

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