ochre-sdk 0.21.0 → 0.21.2

package/dist/index.d.mts

@@ -771,6 +771,28 @@ type Scope = {
   type: string;
   identification: Identification;
 };
+/**
+ * Represents a stylesheet item with its UUID and category
+ */
+type StylesheetCategory = Extract<DataCategory, "propertyVariable" | "propertyValue">;
+type StylesheetItem = {
+  uuid: string;
+  category: "propertyVariable";
+  styles: {
+    default: Array<Style>;
+    tablet: Array<Style>;
+    mobile: Array<Style>;
+  };
+} | {
+  uuid: string;
+  category: "propertyValue";
+  variableUuid: string;
+  styles: {
+    default: Array<Style>;
+    tablet: Array<Style>;
+    mobile: Array<Style>;
+  };
+};
 /**
  * Represents the OCHRE website type
  */
@@ -818,6 +840,7 @@ type Website = {
     };
     footer: {
       isDisplayed: boolean;
+      logoUuid: string | null;
       items: Array<WebElement | WebBlock> | null;
     };
     sidebar: {
@@ -850,6 +873,9 @@ type Website = {
       labels: {
         title: string | null;
       };
+      stylesheets: {
+        properties: Array<StylesheetItem>;
+      };
     };
   };
 };
@@ -1477,4 +1503,4 @@ declare const DEFAULT_PAGE_SIZE = 48;
  */
 declare function flattenItemProperties<T extends DataCategory = DataCategory, U extends DataCategory | Array<DataCategory> = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? Array<DataCategory> : never)>(item: Item<T, U>): Item<T, U>;
 //#endregion
-export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Query, QueryGroup, QueryLeaf, Resource, Scope, Section, Set, SetAttributeValueQueryItem, SetItemsSort, SetItemsSortDirection, SpatialUnit, Style, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsiteType, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Query, QueryGroup, QueryLeaf, Resource, Scope, Section, Set, SetAttributeValueQueryItem, SetItemsSort, SetItemsSortDirection, SpatialUnit, Style, StylesheetCategory, StylesheetItem, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsiteType, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/dist/index.mjs

@@ -3809,6 +3809,37 @@ function parseAllOptionContexts(options) {
 		prominent: handleContexts(options.prominentContexts)
 	};
 }
+function parseStylesheets(styles) {
+	return styles.map((style) => {
+		const defaultStyles = [];
+		for (const [label, value] of Object.entries(style)) {
+			if (label === "variableUuid" || label === "valueUuid" || label === "category" || label === "content") continue;
+			defaultStyles.push({
+				label,
+				value: parseFakeString(value)
+			});
+		}
+		const stylesByViewport = {
+			default: defaultStyles,
+			tablet: [],
+			mobile: []
+		};
+		if (style.category === "propertyValue" || style.valueUuid != null) {
+			if (style.valueUuid == null) throw new Error(`Stylesheet property value "${style.variableUuid}" is missing a value UUID`);
+			return {
+				uuid: style.valueUuid,
+				category: "propertyValue",
+				variableUuid: style.variableUuid,
+				styles: stylesByViewport
+			};
+		}
+		return {
+			uuid: style.variableUuid,
+			category: "propertyVariable",
+			styles: stylesByViewport
+		};
+	});
+}
 /**
 * Parses raw web element properties into a standardized WebElementComponent structure
 *
@@ -4884,6 +4915,7 @@ function parseWebsiteProperties(properties, websiteTree, sidebar) {
 		},
 		footer: {
 			isDisplayed: true,
+			logoUuid: null,
 			items: null
 		},
 		sidebar,
@@ -4902,7 +4934,8 @@ function parseWebsiteProperties(properties, websiteTree, sidebar) {
 		options: {
 			contexts: null,
 			scopes: null,
-			labels: { title: null }
+			labels: { title: null },
+			stylesheets: { properties: [] }
 		}
 	};
 	const contactProperty = getPropertyByLabel(websiteProperties, "contact");
@@ -4916,7 +4949,7 @@ function parseWebsiteProperties(properties, websiteTree, sidebar) {
 	}
 	returnProperties.theme.isThemeToggleDisplayed = getPropertyValueByLabel(websiteProperties, "supports-theme-toggle") ?? true;
 	returnProperties.theme.defaultTheme = getPropertyValueByLabel(websiteProperties, "default-theme") ?? "system";
-	returnProperties.icon.logoUuid = getPropertyByLabel(websiteProperties, "logo")?.values[0]?.uuid ?? null;
+	returnProperties.icon.logoUuid = getPropertyByLabel(websiteProperties, "navbar-logo")?.values[0]?.uuid ?? null;
 	returnProperties.icon.faviconUuid = getPropertyByLabel(websiteProperties, "favicon-ico")?.values[0]?.uuid ?? null;
 	returnProperties.icon.appleTouchIconUuid = getPropertyByLabel(websiteProperties, "favicon-img")?.values[0]?.uuid ?? null;
 	returnProperties.navbar.isDisplayed = getPropertyValueByLabel(websiteProperties, "navbar-displayed") ?? true;
@@ -4925,6 +4958,7 @@ function parseWebsiteProperties(properties, websiteTree, sidebar) {
 	returnProperties.navbar.isProjectDisplayed = getPropertyValueByLabel(websiteProperties, "navbar-project-displayed") ?? true;
 	returnProperties.navbar.searchBarBoundElementUuid = getPropertyByLabel(websiteProperties, "bound-element-navbar-search-bar")?.values[0]?.uuid ?? null;
 	returnProperties.footer.isDisplayed = getPropertyValueByLabel(websiteProperties, "footer-displayed") ?? true;
+	returnProperties.footer.logoUuid = getPropertyByLabel(websiteProperties, "footer-logo")?.values[0]?.uuid ?? null;
 	const itemPageTypeProperty = getPropertyByLabelAndValue(websiteProperties, "page-type", "item-page");
 	if (itemPageTypeProperty !== null) {
 		returnProperties.itemPage.isMainContentDisplayed = getPropertyValueByLabel(itemPageTypeProperty.properties, "item-page-main-content-displayed") ?? true;
@@ -4950,6 +4984,7 @@ function parseWebsiteProperties(properties, websiteTree, sidebar) {
 			returnProperties.options.labels.title = labelNotes.find((note) => note.title === "Title label")?.content ?? null;
 		}
 	}
+	if ("styleOptions" in websiteTree && websiteTree.styleOptions != null) returnProperties.options.stylesheets.properties = parseStylesheets(ensureArray(websiteTree.styleOptions.style));
 	return returnProperties;
 }
 function parseContexts(contexts) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "0.21.0",
+  "version": "0.21.2",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -51,7 +51,7 @@
     "bumpp": "^11.0.1",
     "eslint": "^10.1.0",
     "prettier": "^3.8.1",
-    "tsdown": "^0.21.4",
+    "tsdown": "^0.21.5",
     "typescript": "^6.0.2"
   },
   "scripts": {