@digitalculture/ochre-sdk 0.12.1 → 0.12.3

package/dist/index.d.mts

@@ -545,29 +545,26 @@ type Website = {
       mobile: Array<Style>;
     };
   } | null;
-  properties: WebsiteProperties;
-};
-/**
- * Properties for configuring website display and styling
- */
-type WebsiteProperties = {
-  type: "traditional" | "digital-collection" | "plum" | "cedar" | "elm" | "maple" | "oak" | "palm";
-  privacy: "public" | "password" | "private";
-  status: "development" | "preview" | "production";
-  contact: {
-    name: string;
-    email: string | null;
-  } | null;
-  isHeaderDisplayed: boolean;
-  headerVariant: "default" | "floating" | "inline";
-  headerAlignment: "start" | "center" | "end";
-  isHeaderProjectDisplayed: boolean;
-  isFooterDisplayed: boolean;
-  isSidebarDisplayed: boolean;
-  iiifViewer: "universal-viewer" | "clover";
-  supportsThemeToggle: boolean;
-  defaultTheme: "light" | "dark" | null;
-  logoUrl: string | null;
+  properties: {
+    type: "traditional" | "digital-collection" | "plum" | "cedar" | "elm" | "maple" | "oak" | "palm";
+    privacy: "public" | "password" | "private";
+    status: "development" | "preview" | "production";
+    contact: {
+      name: string;
+      email: string | null;
+    } | null;
+    isHeaderDisplayed: boolean;
+    headerVariant: "default" | "floating" | "inline";
+    headerAlignment: "start" | "center" | "end";
+    isHeaderProjectDisplayed: boolean;
+    isFooterDisplayed: boolean;
+    isSidebarDisplayed: boolean;
+    headerSearchButtonPageSlug: string | null;
+    iiifViewer: "universal-viewer" | "clover";
+    supportsThemeToggle: boolean;
+    defaultTheme: "light" | "dark" | null;
+    logoUrl: string | null;
+  };
 };
 type Webpage = {
   title: string;
@@ -661,6 +658,7 @@ type WebElementComponent = {
   variant: "full" | "highlights";
   itemVariant: "detailed" | "card" | "tile";
   paginationVariant: "default" | "numeric";
+  isSearchDisplayed: boolean;
   isSortDisplayed: boolean;
   isFilterDisplayed: boolean;
   filterSort: "default" | "alphabetical";
@@ -1191,4 +1189,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, WebsiteProperties, 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, WebpageProperties, Website, fetchByUuidMetadata, fetchGallery, fetchItem, fetchPropertyQuery, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/dist/index.mjs

@@ -1,5 +1,4 @@
 import * as z from "zod";
-import { writeFileSync } from "node:fs";
 
 //#region src/schemas.ts
 /**
@@ -1792,6 +1791,9 @@ 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 isSortDisplayed = false;
 			const isSortDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "sort-displayed");
 			if (isSortDisplayedProperty !== null) isSortDisplayed = isSortDisplayedProperty === true;
@@ -1847,6 +1849,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			properties.variant = variant;
 			properties.itemVariant = itemVariant;
 			properties.paginationVariant = paginationVariant;
+			properties.isSearchDisplayed = isSearchDisplayed;
 			properties.isSortDisplayed = isSortDisplayed;
 			properties.isFilterDisplayed = isFilterDisplayed;
 			properties.filterSort = filterSort;
@@ -2561,7 +2564,7 @@ function parseWebBlock(blockResource) {
 	return returnBlock;
 }
 /**
-* Parses raw website properties into a standardized WebsiteProperties structure
+* Parses raw website properties into a standardized Website properties structure
 *
 * @param properties - Array of raw website properties in OCHRE format
 * @returns Parsed WebsiteProperties object
@@ -2612,6 +2615,7 @@ function parseWebsiteProperties(properties) {
 	if (footerProperty) isFooterDisplayed = footerProperty.content === true;
 	const sidebarProperty = websiteProperties.find((property) => property.label === "sidebar-visible")?.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 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];
@@ -2630,6 +2634,7 @@ function parseWebsiteProperties(properties) {
 		isHeaderProjectDisplayed,
 		isFooterDisplayed,
 		isSidebarDisplayed,
+		headerSearchButtonPageSlug,
 		iiifViewer,
 		supportsThemeToggle,
 		defaultTheme,
@@ -2670,7 +2675,7 @@ function parseContexts(contexts) {
 	}
 	return contextsParsed;
 }
-function parseWebsite(websiteTree, projectName, website$1, { isVersion2 = false } = {}) {
+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]);
 	if (typeof websiteTree.items === "string" || !("resource" in websiteTree.items)) throw new Error("Website pages not found");
@@ -2684,7 +2689,7 @@ function parseWebsite(websiteTree, projectName, website$1, { isVersion2 = false
 		identification: parseIdentification(websiteTree.identification),
 		project: {
 			name: parseFakeString(projectName),
-			website: website$1 !== null ? parseFakeString(website$1) : null
+			website: website !== null ? parseFakeString(website) : null
 		},
 		creators: websiteTree.creators ? parsePersons(Array.isArray(websiteTree.creators.creator) ? websiteTree.creators.creator : [websiteTree.creators.creator]) : [],
 		license: parseLicense(websiteTree.availability),
@@ -3124,12 +3129,12 @@ const V2_ABBREVIATIONS = new Set(["bengali-song"]);
 */
 async function fetchWebsite(abbreviation, options) {
 	try {
-		const customFetch = options?.customFetch;
-		const isVersion2 = options?.isVersion2 ?? false;
 		const cleanAbbreviation = abbreviation.trim().toLocaleLowerCase("en-US");
+		const customFetch = options?.customFetch;
+		const isVersion2 = V2_ABBREVIATIONS.has(cleanAbbreviation) ? true : options?.isVersion2 ?? false;
 		let metadata = null;
 		let tree = null;
-		if (V2_ABBREVIATIONS.has(cleanAbbreviation) || isVersion2) {
+		if (isVersion2) {
 			const response = await (customFetch ?? fetch)(`https://ochre.lib.uchicago.edu/ochre/v2/ochre.php?xquery=${encodeURIComponent(`collection('ochre/tree')/ochre[tree/identification/abbreviation/content/string='${cleanAbbreviation}']`)}&format=json&lang="*"`);
 			if (!response.ok) throw new Error("Failed to fetch website");
 			const data = await response.json();
@@ -3147,14 +3152,12 @@ async function fetchWebsite(abbreviation, options) {
 			tree = result.ochre.tree;
 		}
 		const projectIdentification = metadata.project?.identification ? parseIdentification(metadata.project.identification) : null;
-		return [null, parseWebsite(tree, projectIdentification?.label ?? "", metadata.project?.identification.website ?? null, { isVersion2: true })];
+		return [null, parseWebsite(tree, projectIdentification?.label ?? "", metadata.project?.identification.website ?? null, { isVersion2 })];
 	} catch (error) {
 		console.error(error);
 		return [error instanceof Error ? error.message : "Unknown error", null];
 	}
 }
-const [_, website] = await fetchWebsite("bengali-song");
-writeFileSync("website.json", JSON.stringify(website, null, 2));
 
 //#endregion
 export { fetchByUuidMetadata, fetchGallery, fetchItem, fetchPropertyQuery, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/package.json

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