ochre-sdk 1.0.21 → 1.0.22

package/dist/parsers/website/index.mjs

@@ -36,11 +36,45 @@ function normalizeWebsiteResources(resources) {
 	return normalized;
 }
 const SEGMENT_UNIQUE_SLUG_PREFIX_REGEX = /^\$[^-]*-/;
+function cleanWebsitePageSlug(slug) {
+	return slug?.replace(SEGMENT_UNIQUE_SLUG_PREFIX_REGEX, "") ?? null;
+}
 function prefixSlug(slug, slugPrefix) {
 	if (slugPrefix == null || slugPrefix === "") return slug;
 	if (slug === "") return slugPrefix;
 	return `${slugPrefix}/${slug}`;
 }
+function collectWebsitePageSlugs(resources, options, slugPrefix, pageSlugsByUuid = /* @__PURE__ */ new Map(), segmentSlugPrefix = slugPrefix) {
+	for (const resource of resources ?? []) {
+		if ("segments" in resource) {
+			for (const tree of resource.segments.tree) {
+				const segmentSlug = tree.identification.abbreviation == null ? null : parseStringContent(tree.identification.abbreviation, options);
+				if (segmentSlug == null) throw new Error(`Slug not found for segment website (website uuid “${tree.uuid}”)`, { cause: tree });
+				collectWebsitePageSlugs(tree.items?.resource, options, prefixSlug(segmentSlug, segmentSlugPrefix), pageSlugsByUuid);
+			}
+			continue;
+		}
+		if (!("identification" in resource)) {
+			collectWebsitePageSlugs(resource.resource, options, slugPrefix, pageSlugsByUuid, segmentSlugPrefix);
+			continue;
+		}
+		if (websitePresentationReader(resource.properties != null ? parseSimplifiedProperties(resource.properties, options) : []).value("presentation") === "page") {
+			const slug = cleanWebsitePageSlug(resource.slug);
+			if (slug == null) throw new Error(`Slug not found for page (${formatXMLWebsiteResourceMetadata(resource)})`, { cause: resource });
+			const pageSlug = prefixSlug(slug, slugPrefix);
+			pageSlugsByUuid.set(resource.uuid, pageSlug);
+			collectWebsitePageSlugs(resource.resource, options, slugPrefix == null ? void 0 : pageSlug, pageSlugsByUuid, pageSlug);
+			continue;
+		}
+		collectWebsitePageSlugs(resource.resource, options, slugPrefix, pageSlugsByUuid, segmentSlugPrefix);
+	}
+	return pageSlugsByUuid;
+}
+function parseWebsiteLinkTarget(value, context) {
+	if (value == null) return null;
+	if (value.href != null) return transformPermanentIdentificationUrlToItemLink(value.href);
+	return (value.uuid == null ? void 0 : context.pageSlugsByUuid?.get(value.uuid)) ?? value.slug;
+}
 function formatXMLWebsiteResourceMetadata(resource) {
 	const metadata = [`label “${parseStringContent(resource.identification.label)}”`, `uuid “${resource.uuid}”`];
 	if (resource.slug != null) metadata.push(`slug “${resource.slug}”`);
@@ -205,7 +239,7 @@ function parseStylesheets(styles) {
 * @param elementResource - Raw element resource data in OCHRE format
 * @returns Parsed WebElementComponent object
 */
-function parseWebElementProperties(componentProperty, elementResource, options) {
+function parseWebElementProperties(componentProperty, elementResource, options, context) {
 	const unparsedComponentName = componentProperty.values[0].content;
 	const componentNameResult = v.safeParse(componentSchema, unparsedComponentName);
 	const componentName = componentNameResult.success ? componentNameResult.output : void 0;
@@ -229,7 +263,7 @@ function parseWebElementProperties(componentProperty, elementResource, options)
 		}
 		case "advanced-search": {
 			const boundElementPropertyUuid = componentReader.uuid("bound-element");
-			const href = componentReader.linkTarget("link-to", transformPermanentIdentificationUrlToItemLink);
+			const href = parseWebsiteLinkTarget(componentReader.valueNode("link-to"), context);
 			if (boundElementPropertyUuid == null && href == null) throw new Error(formatComponentError("Bound element or href not found", componentName, elementResource), { cause: componentProperty });
 			properties = {
 				component: "advanced-search",
@@ -297,9 +331,9 @@ function parseWebElementProperties(componentProperty, elementResource, options)
 		case "button": {
 			const variant = componentReader.valueOr("variant", "default");
 			let isExternal = false;
-			let href = componentReader.linkTarget("navigate-to", transformPermanentIdentificationUrlToItemLink);
+			let href = parseWebsiteLinkTarget(componentReader.valueNode("navigate-to"), context);
 			if (href === null) {
-				href = componentReader.linkTarget("link-to", transformPermanentIdentificationUrlToItemLink);
+				href = parseWebsiteLinkTarget(componentReader.valueNode("link-to"), context);
 				if (href === null) throw new Error(formatComponentError("Properties “navigate-to” or “link-to” not found", componentName, elementResource), { cause: componentProperty });
 				else isExternal = true;
 			}
@@ -594,7 +628,7 @@ function parseWebElementProperties(componentProperty, elementResource, options)
 		case "search-bar": {
 			const queryVariant = componentReader.valueOr("query-variant", "submit");
 			const boundElementUuid = componentReader.uuid("bound-element");
-			const href = componentReader.linkTarget("link-to", transformPermanentIdentificationUrlToItemLink);
+			const href = parseWebsiteLinkTarget(componentReader.valueNode("link-to"), context);
 			if (!boundElementUuid && !href) throw new Error(formatComponentError("Bound element or href not found", componentName, elementResource), { cause: componentProperty });
 			properties = {
 				component: "search-bar",
@@ -705,10 +739,10 @@ function parseWebTitle(properties, identification, overrides) {
 * @param elementResource - Raw element resource data in OCHRE format
 * @returns Parsed WebElement object
 */
-function parseWebElement(elementResource, options) {
+function parseWebElement(elementResource, options, context) {
 	const identification = parseIdentification(elementResource.identification, options);
 	const elementProperties = elementResource.properties?.property ? parseSimplifiedProperties(elementResource.properties, options) : [];
-	const properties = parseWebElementProperties(websitePresentationReader(websitePresentationReader(elementProperties).requiredProperty("presentation", `Presentation property not found for element (${formatXMLWebsiteResourceMetadata(elementResource)})`).properties).requiredProperty("component", `Component property not found for element (${formatXMLWebsiteResourceMetadata(elementResource)})`), elementResource, options);
+	const properties = parseWebElementProperties(websitePresentationReader(websitePresentationReader(elementProperties).requiredProperty("presentation", `Presentation property not found for element (${formatXMLWebsiteResourceMetadata(elementResource)})`).properties).requiredProperty("component", `Component property not found for element (${formatXMLWebsiteResourceMetadata(elementResource)})`), elementResource, options, context);
 	const cssStyles = parseResponsiveCssStyles(elementProperties);
 	const title = parseWebTitle(elementProperties, identification, {
 		isNameDisplayed: properties.component === "annotated-image" || properties.component === "annotated-document" || properties.component === "collection",
@@ -733,7 +767,7 @@ function parseWebpage(webpageResource, options, context, slugPrefix) {
 	const webpageReader = websitePresentationReader(webpageProperties);
 	if (webpageReader.value("presentation") !== "page") return null;
 	const identification = parseIdentification(webpageResource.identification, options);
-	const slug = webpageResource.slug?.replace(SEGMENT_UNIQUE_SLUG_PREFIX_REGEX, "") ?? null;
+	const slug = cleanWebsitePageSlug(webpageResource.slug);
 	if (slug == null) throw new Error(`Slug not found for page (${formatXMLWebsiteResourceMetadata(webpageResource)})`, { cause: webpageResource });
 	const returnWebpage = {
 		uuid: webpageResource.uuid,
@@ -767,12 +801,12 @@ function parseWebpage(webpageResource, options, context, slugPrefix) {
 		if (resourceType === null) continue;
 		switch (resourceType) {
 			case "element": {
-				const element = parseWebElement(resource, options);
+				const element = parseWebElement(resource, options, context);
 				items.push(element);
 				break;
 			}
 			case "block": {
-				const block = parseWebBlock(resource, options);
+				const block = parseWebBlock(resource, options, context);
 				if (block) items.push(block);
 				break;
 			}
@@ -836,7 +870,7 @@ function parseWebsiteSegments(resources, context, options, slugPrefix) {
 * @param resources - Array of raw sidebar resources in OCHRE format
 * @returns Parsed Sidebar object
 */
-function parseSidebar(resources, options) {
+function parseSidebar(resources, options, context) {
 	let returnSidebar = null;
 	const items = [];
 	let title = null;
@@ -867,12 +901,12 @@ function parseSidebar(resources, options) {
 			if (resourceType === null) continue;
 			switch (resourceType) {
 				case "element": {
-					const element = parseWebElement(resource, options);
+					const element = parseWebElement(resource, options, context);
 					items.push(element);
 					break;
 				}
 				case "block": {
-					const block = parseWebBlock(resource, options);
+					const block = parseWebBlock(resource, options, context);
 					if (block) items.push(block);
 					break;
 				}
@@ -889,20 +923,20 @@ function parseSidebar(resources, options) {
 	};
 	return returnSidebar;
 }
-function parseWebAccordionItem(elementResource, childResources, options) {
-	const trigger = parseWebElement(elementResource, options);
+function parseWebAccordionItem(elementResource, childResources, options, context) {
+	const trigger = parseWebElement(elementResource, options, context);
 	const items = [];
 	for (const resource of childResources) {
 		const resourceType = websitePresentationReader(resource.properties ? parseSimplifiedProperties(resource.properties, options) : []).value("presentation");
 		if (resourceType === null) continue;
 		switch (resourceType) {
 			case "element": {
-				const element = parseWebElement(resource, options);
+				const element = parseWebElement(resource, options, context);
 				items.push(element);
 				break;
 			}
 			case "block": {
-				const block = parseWebBlock(resource, options);
+				const block = parseWebBlock(resource, options, context);
 				if (block) items.push(block);
 				break;
 			}
@@ -921,7 +955,7 @@ function parseWebAccordionItem(elementResource, childResources, options) {
 * @param blockResource - Raw block resource data in OCHRE format
 * @returns Parsed WebBlock object
 */
-function parseWebBlock(blockResource, options) {
+function parseWebBlock(blockResource, options, context) {
 	const blockProperties = blockResource.properties ? parseSimplifiedProperties(blockResource.properties, options) : [];
 	const returnBlock = {
 		uuid: blockResource.uuid,
@@ -1006,16 +1040,16 @@ function parseWebBlock(blockResource, options) {
 				const childResources = resource.resource ? normalizeWebsiteResources(resource.resource) : [];
 				const componentType = resourceReader.nestedByValue("presentation", "element").value("component");
 				if (supportsAccordionItems && componentType === "text" && childResources.length > 0) {
-					const item = parseWebAccordionItem(resource, childResources, options);
+					const item = parseWebAccordionItem(resource, childResources, options, context);
 					blockItems.push(item);
 					break;
 				}
-				const element = parseWebElement(resource, options);
+				const element = parseWebElement(resource, options, context);
 				blockItems.push(element);
 				break;
 			}
 			case "block": {
-				const block = parseWebBlock(resource, options);
+				const block = parseWebBlock(resource, options, context);
 				if (block) blockItems.push(block);
 				break;
 			}
@@ -1200,7 +1234,12 @@ function parseWebsiteTree(websiteTree, context, type, options, 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 });
 	const resources = normalizeWebsiteResources(websiteTree.items?.resource);
-	const sidebar = parseSidebar(resources, options);
+	const pageSlugsByUuid = context.pageSlugsByUuid ?? collectWebsitePageSlugs(websiteTree.items?.resource, options, slugPrefix);
+	const treeContext = {
+		...context,
+		pageSlugsByUuid
+	};
+	const sidebar = parseSidebar(resources, options, treeContext);
 	const properties = parseWebsiteProperties(websiteTree.properties.property, websiteTree, sidebar, options);
 	return {
 		uuid: websiteTree.uuid,
@@ -1211,7 +1250,7 @@ function parseWebsiteTree(websiteTree, context, type, options, slugPrefix) {
 		identification: parseIdentification(websiteTree.identification, options),
 		creators: websiteTree.creators ? parsePersonList(websiteTree.creators.creator, options) : [],
 		license: parseLicense(websiteTree.availability),
-		items: parseWebpages(resources, options, context, slugPrefix),
+		items: parseWebpages(resources, options, treeContext, slugPrefix),
 		properties
 	};
 }

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

@@ -17,7 +17,6 @@ declare class WebsitePresentationReader<T extends LanguageCodes> {
   stringValue(label: string): string | null;
   numberValue(label: string): number | null;
   uuid(label: string): string | null;
-  linkTarget(label: string, transformHref: (href: string) => string): string | null;
   multilingualValue(label: string, options: ParserOptions<T>): MultilingualString<T> | null;
   nested(label: string): WebsitePresentationReader<T>;
   nestedByValue(label: string, value: WebsitePropertyContent<T>): WebsitePresentationReader<T>;

package/dist/parsers/website/reader.mjs

@@ -44,11 +44,6 @@ var WebsitePresentationReader = class WebsitePresentationReader {
 	uuid(label) {
 		return this.valueNode(label)?.uuid ?? null;
 	}
-	linkTarget(label, transformHref) {
-		const value = this.valueNode(label);
-		if (value?.href != null) return transformHref(value.href);
-		return value?.slug ?? null;
-	}
 	multilingualValue(label, options) {
 		const value = this.valueNode(label);
 		if (value == null) return null;

package/package.json

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