@digitalculture/ochre-sdk 0.12.12 → 0.12.14

package/dist/index.d.mts

@@ -560,10 +560,24 @@ type Website = {
     isFooterDisplayed: boolean;
     isSidebarDisplayed: boolean;
     headerSearchBarPageSlug: string | null;
-    iiifViewer: "universal-viewer" | "clover";
     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>;
+        };
+      };
+    };
   };
 };
 /**
@@ -670,7 +684,7 @@ type WebElementComponent = {
   isFilterDisplayed: boolean;
   filterSort: "default" | "alphabetical";
   search: {
-    isInputDisplayed: boolean;
+    isUsingQueryParams: boolean;
     isResultsBarDisplayed: boolean;
     isMapDisplayed: boolean;
   };

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
 			};
@@ -2605,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;
@@ -2659,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,
@@ -2671,10 +2701,13 @@ function parseWebsiteProperties(properties) {
 		isFooterDisplayed,
 		isSidebarDisplayed,
 		headerSearchBarPageSlug,
-		iiifViewer,
 		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) {
@@ -2713,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);
@@ -3133,7 +3166,7 @@ const KNOWN_ABBREVIATIONS = {
 	ssmc: "8ff977dd-d440-40f5-ad93-8ad7e2d39e74",
 	"sosc-core-at-smart": "db26c953-9b2a-4691-a909-5e8726b531d7"
 };
-const V2_ABBREVIATIONS = new Set(["bengali-song"]);
+const V2_ABBREVIATIONS = /* @__PURE__ */ new Set();
 /**
 * Fetches and parses a website configuration from the OCHRE API
 *

package/package.json

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