@digitalculture/ochre-sdk 0.12.11 → 0.12.13

package/dist/index.d.mts

@@ -559,36 +559,53 @@ type Website = {
     isHeaderProjectDisplayed: boolean;
     isFooterDisplayed: boolean;
     isSidebarDisplayed: boolean;
-    headerSearchButtonPageSlug: string | null;
-    iiifViewer: "universal-viewer" | "clover";
+    headerSearchBarPageSlug: string | null;
     supportsThemeToggle: boolean;
     defaultTheme: "light" | "dark" | null;
     logoUrl: string | null;
+    itemPage: {
+      iiifViewer: "universal-viewer" | "clover";
+      options: {
+        contexts: {
+          flatten: Array<LevelContext>;
+          suppress: Array<LevelContext>;
+          filter: Array<LevelContext>;
+          sort: Array<LevelContext>;
+          detail: Array<LevelContext>;
+          download: Array<LevelContext>;
+          label: Array<LevelContext>;
+          prominent: Array<LevelContext>;
+        };
+      };
+    };
   };
 };
+/**
+ * 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";
@@ -667,7 +684,7 @@ type WebElementComponent = {
   isFilterDisplayed: boolean;
   filterSort: "default" | "alphabetical";
   search: {
-    isInputDisplayed: boolean;
+    isUsingQueryParams: boolean;
     isResultsBarDisplayed: boolean;
     isMapDisplayed: boolean;
   };
@@ -1204,4 +1221,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,9 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			itemVariant ??= "detailed";
 			let paginationVariant = getPropertyValueByLabel(componentProperty.properties, "pagination-variant");
 			paginationVariant ??= "default";
-			let isInputDisplayed = false;
-			const isInputDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "input-displayed");
-			if (isInputDisplayedProperty !== null) isInputDisplayed = isInputDisplayedProperty === true;
+			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;
@@ -1866,7 +1866,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			properties.itemVariant = itemVariant;
 			properties.paginationVariant = paginationVariant;
 			properties.search = {
-				isInputDisplayed,
+				isUsingQueryParams,
 				isResultsBarDisplayed,
 				isMapDisplayed
 			};
@@ -2257,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];
@@ -2265,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 = [];
@@ -2299,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,
@@ -2601,7 +2605,7 @@ function parseWebBlock(blockResource) {
 * @param properties - Array of raw website properties in OCHRE format
 * @returns Parsed WebsiteProperties object
 */
-function parseWebsiteProperties(properties) {
+function parseWebsiteProperties(properties, websiteTree) {
 	const websiteProperties = parseProperties(properties).find((property) => property.label === "presentation")?.properties;
 	if (!websiteProperties) throw new Error("Presentation property not found");
 	let type = websiteProperties.find((property) => property.label === "webUI")?.values[0]?.content;
@@ -2635,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];
@@ -2655,6 +2659,36 @@ function parseWebsiteProperties(properties) {
 	const defaultThemeProperty = websiteProperties.find((property) => property.label === "default-theme")?.values[0];
 	if (defaultThemeProperty) defaultTheme = defaultThemeProperty.content;
 	const { type: validatedType, status: validatedStatus, privacy: validatedPrivacy } = result.data;
+	let contexts = {
+		flatten: [],
+		suppress: [],
+		filter: [],
+		sort: [],
+		detail: [],
+		download: [],
+		label: [],
+		prominent: []
+	};
+	if ("options" in websiteTree && websiteTree.options) {
+		const flattenContextsRaw = websiteTree.options.flattenContexts != null ? Array.isArray(websiteTree.options.flattenContexts) ? websiteTree.options.flattenContexts : [websiteTree.options.flattenContexts] : [];
+		const suppressContextsRaw = websiteTree.options.suppressContexts != null ? Array.isArray(websiteTree.options.suppressContexts) ? websiteTree.options.suppressContexts : [websiteTree.options.suppressContexts] : [];
+		const filterContextsRaw = websiteTree.options.filterContexts != null ? Array.isArray(websiteTree.options.filterContexts) ? websiteTree.options.filterContexts : [websiteTree.options.filterContexts] : [];
+		const sortContextsRaw = websiteTree.options.sortContexts != null ? Array.isArray(websiteTree.options.sortContexts) ? websiteTree.options.sortContexts : [websiteTree.options.sortContexts] : [];
+		const detailContextsRaw = websiteTree.options.detailContexts != null ? Array.isArray(websiteTree.options.detailContexts) ? websiteTree.options.detailContexts : [websiteTree.options.detailContexts] : [];
+		const downloadContextsRaw = websiteTree.options.downloadContexts != null ? Array.isArray(websiteTree.options.downloadContexts) ? websiteTree.options.downloadContexts : [websiteTree.options.downloadContexts] : [];
+		const labelContextsRaw = websiteTree.options.labelContexts != null ? Array.isArray(websiteTree.options.labelContexts) ? websiteTree.options.labelContexts : [websiteTree.options.labelContexts] : [];
+		const prominentContextsRaw = websiteTree.options.prominentContexts != null ? Array.isArray(websiteTree.options.prominentContexts) ? websiteTree.options.prominentContexts : [websiteTree.options.prominentContexts] : [];
+		contexts = {
+			flatten: parseContexts(flattenContextsRaw),
+			suppress: parseContexts(suppressContextsRaw),
+			filter: parseContexts(filterContextsRaw),
+			sort: parseContexts(sortContextsRaw),
+			detail: parseContexts(detailContextsRaw),
+			download: parseContexts(downloadContextsRaw),
+			label: parseContexts(labelContextsRaw),
+			prominent: parseContexts(prominentContextsRaw)
+		};
+	}
 	return {
 		type: validatedType,
 		privacy: validatedPrivacy,
@@ -2666,11 +2700,14 @@ function parseWebsiteProperties(properties) {
 		isHeaderProjectDisplayed,
 		isFooterDisplayed,
 		isSidebarDisplayed,
-		headerSearchButtonPageSlug,
-		iiifViewer,
+		headerSearchBarPageSlug,
 		supportsThemeToggle,
 		defaultTheme,
-		logoUrl: logoUuid !== null ? `https://ochre.lib.uchicago.edu/ochre?uuid=${logoUuid}&load` : null
+		logoUrl: logoUuid !== null ? `https://ochre.lib.uchicago.edu/ochre?uuid=${logoUuid}&load` : null,
+		itemPage: {
+			iiifViewer,
+			options: { contexts }
+		}
 	};
 }
 function parseContexts(contexts) {
@@ -2709,7 +2746,7 @@ function parseContexts(contexts) {
 }
 function parseWebsite(websiteTree, projectName, website, { isVersion2 = false } = {}) {
 	if (!websiteTree.properties) throw new Error("Website properties not found");
-	const properties = parseWebsiteProperties(Array.isArray(websiteTree.properties.property) ? websiteTree.properties.property : [websiteTree.properties.property]);
+	const properties = parseWebsiteProperties(Array.isArray(websiteTree.properties.property) ? websiteTree.properties.property : [websiteTree.properties.property], websiteTree);
 	if (typeof websiteTree.items === "string" || !("resource" in websiteTree.items)) throw new Error("Website pages not found");
 	const resources = Array.isArray(websiteTree.items.resource) ? websiteTree.items.resource : [websiteTree.items.resource];
 	const pages = parseWebpages(resources);

package/package.json

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