ochre-sdk 1.3.17 → 1.3.19

package/dist/fetchers/website-metadata.mjs

@@ -90,6 +90,16 @@ declare function local:matching-pages($resources, $target-slug, $slug-prefix) {
   )
 };
 
+declare function local:oak-collection-pages($tree, $resources, $target-slug) {
+  if ($tree/properties/property[label/string() = "presentation"][value/string() = "website"]/property[label/string() = "webUI"]/value/string() = "oak") then
+    for $resource in $resources[local:presentation(.) = "element"]
+    let $slug := local:clean-slug($resource/@slug)
+    where string(($resource/properties/property[label/string() = "presentation"]/property[label/string() = "component"]/value)[1]) = "collection"
+      and (if ($slug != "") then $slug else string(($resource/identification/abbreviation/content/string)[1])) = $target-slug
+    return local:metadata-page($resource)
+  else ()
+};
+
 declare function local:metadata-tree($tree, $target-slug, $slug-prefix) {
   let $resources := local:resource-items($tree/items/resource)
   let $presentation-properties := $tree/properties/property[label/string() = "presentation"][value/string() = "website"]/property[label/string() = (${Object.values(METADATA_PRESENTATION_LABELS).map((label) => stringLiteral(label)).join(", ")})]
@@ -103,7 +113,8 @@ declare function local:metadata-tree($tree, $target-slug, $slug-prefix) {
           $resources[local:presentation(.) = "page"],
           $target-slug,
           $slug-prefix
-        )
+        ),
+        local:oak-collection-pages($tree, $resources, $target-slug)
       }
     }
 };

package/dist/parsers/website/components.mjs

@@ -65,7 +65,8 @@ function parseCollectionPropertyOverrides(reader) {
 	read("isSortDisplayed", "sort-displayed");
 	read("isUsingQueryParams", "is-using-query-params");
 	read("isInteractive", "is-interactive");
-	readImage("layout", "image-layout");
+	const imageLayout = reader.value("image-layout");
+	if (imageLayout != null) imageOverrides.layout = imageLayout === "suppress" ? null : imageLayout;
 	readImage("fit", "image-fit");
 	readImage("alignment", "image-alignment");
 	readImage("isPlaceholderDisplayed", "image-placeholder-displayed");
@@ -455,6 +456,24 @@ function parseMapComponent(parameters) {
 	let maximumBounds = null;
 	const maximumBoundsProperty = componentReader.value("maximum-bounds");
 	if (maximumBoundsProperty !== null) maximumBounds = parseBounds(String(maximumBoundsProperty));
+	const layerSettings = [];
+	for (const layerReader of componentReader.nestedAllByValue("customize-special", "map-layer")) {
+		const uuid = layerReader.uuid("use-layer");
+		if (uuid == null) continue;
+		const opacity = layerReader.value("opacity-percent");
+		const filterFields = layerReader.stringValues("filter-field");
+		layerSettings.push({
+			uuid,
+			isBasemap: layerReader.value("is-basemap"),
+			isDisplayedByDefault: layerReader.value("displayed-by-default"),
+			opacity: typeof opacity === "number" ? Math.min(Math.max(opacity, 0), 100) / 100 : null,
+			ochreLinkField: layerReader.stringValue("ochre-link-field"),
+			periodField: layerReader.stringValue("period-field"),
+			periodOrder: layerReader.stringValues("period-order"),
+			filterFields: filterFields.length > 0 ? filterFields : null,
+			markerColor: layerReader.stringValue("marker-color")
+		});
+	}
 	return {
 		component: "map",
 		linkUuids,
@@ -462,6 +481,7 @@ function parseMapComponent(parameters) {
 		customBasemap,
 		initialBounds,
 		maximumBounds,
+		layerSettings,
 		...properties
 	};
 }

package/dist/parsers/website/index.mjs

@@ -1,9 +1,11 @@
-import { cleanObject, parseLicense, parseRequiredContentLike } from "../helpers.mjs";
+import { cleanObject, parseLicense, parseRequiredContentLike, parseStringContent } from "../helpers.mjs";
 import { parseMetadataLanguages, resolveDefaultLanguage, resolveLanguages } from "../languages.mjs";
 import { parseIdentification, parseLinks, parseMetadata, parsePersonList, parseSimplifiedProperties } from "../index.mjs";
 import { findWebsiteLink, parseWebsiteLinkTarget, webImageFromLink } from "./links.mjs";
+import { formatXMLWebsiteResourceMetadata } from "./messages.mjs";
 import { websitePresentationReader } from "./reader.mjs";
 import { emptyResponsiveStyles, parseResponsiveCssStyles } from "./styles.mjs";
+import { cleanWebsitePageSlug } from "./slug.mjs";
 import { collectWebsitePageSlugs, normalizeWebsiteResources, readWebsitePages } from "./walk.mjs";
 import { parseWebElement, parseWebTitle } from "./components.mjs";
 import { parseWebsiteProperties } from "./properties.mjs";
@@ -53,23 +55,13 @@ function parseWebpageRedirect(redirectValue, context) {
 	};
 	return null;
 }
-/**
-* Parses a walked page node into a standardized Webpage structure
-*
-* @param page - The page node, with its slug and nesting already resolved
-* @returns Parsed Webpage object
-*/
-function parseWebpage(page, options, context) {
-	const webpageResource = page.resource;
-	const webpageProperties = parseSimplifiedProperties(webpageResource.properties, options);
-	const webpageReader = websitePresentationReader(webpageProperties);
-	const identification = parseIdentification(webpageResource.identification, options);
-	const returnWebpage = {
-		uuid: webpageResource.uuid,
+function createWebpage(resource, slug, options) {
+	return {
+		uuid: resource.uuid,
 		type: "page",
-		title: identification.label,
-		slug: page.slug,
-		publicationDateTime: webpageResource.publicationDateTime ?? null,
+		title: parseIdentification(resource.identification, options).label,
+		slug,
+		publicationDateTime: resource.publicationDateTime ?? null,
 		items: [],
 		segments: [],
 		properties: {
@@ -86,6 +78,18 @@ function parseWebpage(page, options, context) {
 		},
 		webpages: []
 	};
+}
+/**
+* Parses a walked page node into a standardized Webpage structure
+*
+* @param page - The page node, with its slug and nesting already resolved
+* @returns Parsed Webpage object
+*/
+function parseWebpage(page, options, context) {
+	const webpageResource = page.resource;
+	const webpageProperties = parseSimplifiedProperties(webpageResource.properties, options);
+	const webpageReader = websitePresentationReader(webpageProperties);
+	const returnWebpage = createWebpage(webpageResource, page.slug, options);
 	const websiteLinks = parseLinks(webpageResource.links, options);
 	const imageLink = findWebsiteLink(websiteLinks, "resource", (link) => link.type === "image" || link.type === "IIIF");
 	const webpageResources = normalizeWebsiteResources(webpageResource.resource);
@@ -265,6 +269,36 @@ function parseWebBlock(blockResource, options, context) {
 	returnBlock.cssStyles = parseResponsiveCssStyles(blockProperties);
 	return returnBlock;
 }
+function parseOakWebsite(resources, webpages, options, context) {
+	const webpagesByUuid = new Map(webpages.map((webpage) => [webpage.uuid, webpage]));
+	const items = [];
+	let map = null;
+	for (const resource of resources) {
+		const webpage = webpagesByUuid.get(resource.uuid);
+		if (webpage != null) {
+			items.push(webpage);
+			continue;
+		}
+		const component = websitePresentationReader(parseSimplifiedProperties(resource.properties, options)).nestedByValue("presentation", "element").value("component");
+		if (component !== "map" && component !== "collection") continue;
+		const element = parseWebElement(resource, options, context.pageSlugsByUuid);
+		if (element.component === "map") {
+			map ??= element;
+			continue;
+		}
+		const resourceSlug = cleanWebsitePageSlug(resource.slug) ?? "";
+		const slug = resourceSlug === "" ? parseStringContent(resource.identification.abbreviation, options) : resourceSlug;
+		if (slug === "") throw new Error(`Slug not found for OAK collection (${formatXMLWebsiteResourceMetadata(resource)})`, { cause: resource });
+		const collectionPage = createWebpage(resource, slug, options);
+		collectionPage.items = [element];
+		collectionPage.properties.isDisplayedInNavbar = false;
+		items.push(collectionPage);
+	}
+	return {
+		items,
+		oak: { map }
+	};
+}
 function parseWebsiteTree(websiteTree, options, context, type, slugPrefix) {
 	if (!websiteTree.properties) throw new Error(`Website properties not found (website uuid “${websiteTree.uuid}”)`, { cause: websiteTree });
 	if (type === "website" && websiteTree.items?.resource == null) throw new Error(`Website pages not found (website uuid “${websiteTree.uuid}”)`, { cause: websiteTree });
@@ -278,6 +312,15 @@ function parseWebsiteTree(websiteTree, options, context, type, slugPrefix) {
 	const sidebar = parseSidebar(resources, options, treeContext);
 	const properties = parseWebsiteProperties(websiteTree.properties.property, websiteTree, sidebar, options, context.parentProperties ?? null);
 	const license = parseLicense(websiteTree.availability) ?? context.parentLicense ?? null;
+	const webpages = parseWebpages(pages, options, {
+		...treeContext,
+		parentProperties: properties,
+		parentLicense: license
+	});
+	const { items, oak } = type === "website" && properties.type === "oak" ? parseOakWebsite(resources, webpages, options, treeContext) : {
+		items: webpages,
+		oak: null
+	};
 	return {
 		uuid: websiteTree.uuid,
 		type,
@@ -287,12 +330,9 @@ function parseWebsiteTree(websiteTree, options, context, type, slugPrefix) {
 		identification: parseIdentification(websiteTree.identification, options),
 		creators: websiteTree.creators ? parsePersonList(websiteTree.creators.creator, options) : [],
 		license,
-		items: parseWebpages(pages, options, {
-			...treeContext,
-			parentProperties: properties,
-			parentLicense: license
-		}),
-		properties
+		items,
+		properties,
+		oak
 	};
 }
 function parseWebsite(data, options) {

package/dist/parsers/website/reader.d.mts

@@ -44,6 +44,7 @@ export declare class WebsitePresentationReader<T extends LanguageCodes> {
    * @returns The string, or null when the property is unset or not string-like
    */
   stringValue(label: string): string | null;
+  stringValues(label: string): Array<string>;
   uuid(label: string): string | null;
   multilingualValue(label: string, options: ParserOptions<T>): MultilingualString<T> | null;
   /**

package/dist/parsers/website/reader.mjs

@@ -63,6 +63,17 @@ var WebsitePresentationReader = class WebsitePresentationReader {
 		if (typeof value === "string") return value;
 		return typeof value === "number" ? value.toString() : null;
 	}
+	stringValues(label) {
+		const values = [];
+		for (const property of this.sourceProperties) {
+			if (getProperty([property], { label }) == null) continue;
+			for (const { content } of property.values) {
+				const value = typeof content === "number" ? content.toString() : content;
+				if (typeof value === "string" && value.trim() !== "") values.push(value.trim());
+			}
+		}
+		return values;
+	}
 	uuid(label) {
 		return this.valueNode(label)?.uuid ?? null;
 	}

package/dist/types/website.d.mts

@@ -219,6 +219,14 @@ export type Website<T extends LanguageCodes = LanguageCodes> = {
       };
     }>;
   };
+  /**
+   * The bare Map element of an OAK website, null for every other design. Its
+   * bare Collection elements are in `items` as pages hidden from the navbar,
+   * in tree order.
+   */
+  oak: {
+    map: WebElementOf<"map", T> | null;
+  } | null;
 };
 export type WebsiteSegment<T extends LanguageCodes = LanguageCodes> = Website<T> & {
   type: "segment";
@@ -358,7 +366,7 @@ export type WebElementComponent<T extends LanguageCodes = LanguageCodes> = {
   paginationVariant: "default" | "numeric";
   loadingVariant: WebLoadingVariant;
   image: {
-    layout: "top" | "bottom" | "start" | "end" | null;
+    layout: "top" | "bottom" | "start" | "end" | "thumbnail" | null;
     fit: "fill" | "fit";
     alignment: "top" | "center" | "bottom" | null;
     isPlaceholderDisplayed: boolean;
@@ -426,6 +434,17 @@ export type WebElementComponent<T extends LanguageCodes = LanguageCodes> = {
   customBasemap: string | null;
   initialBounds: [[number, number], [number, number]] | null;
   maximumBounds: [[number, number], [number, number]] | null;
+  layerSettings: Array<{
+    uuid: string;
+    isBasemap: boolean | null;
+    isDisplayedByDefault: boolean | null;
+    opacity: number | null;
+    ochreLinkField: string | null;
+    periodField: string | null;
+    periodOrder: Array<string>;
+    filterFields: Array<string> | null;
+    markerColor: string | null;
+  }>;
   isControlsDisplayed: boolean;
   isInteractive: boolean;
   isClustered: boolean;

package/package.json

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