ochre-sdk 1.0.55 → 1.0.57

package/dist/parsers/website/index.mjs

@@ -878,10 +878,22 @@ function parseWebpage(webpageResource, options, context, slugPrefix) {
 		returnWebpage.properties.isSidebarDisplayed = pageReader.valueOr("sidebar-displayed", true);
 		returnWebpage.properties.isBreadcrumbsDisplayed = pageReader.valueOr("breadcrumbs-displayed", false);
 		returnWebpage.properties.isNavbarSearchBarDisplayed = pageReader.valueOr("navbar-search-bar-displayed", true);
-		const redirectHref = parseWebsiteLinkTarget(pageReader.valueNode("redirect-to"), context);
-		if (redirectHref != null) returnWebpage.properties.redirect = {
-			href: redirectHref,
-			isExternal: redirectHref.startsWith("http")
+		const redirectValue = pageReader.valueNode("redirect-to");
+		const redirectTarget = parseWebsiteLinkTarget(redirectValue, context);
+		if (redirectTarget != null) if (redirectValue?.href == null && redirectValue?.uuid != null) returnWebpage.properties.redirect = {
+			type: "page",
+			slug: redirectTarget,
+			uuid: redirectValue.uuid
+		};
+		else returnWebpage.properties.redirect = {
+			type: "url",
+			href: redirectTarget,
+			isExternal: redirectTarget.startsWith("http")
+		};
+		else if (redirectValue?.uuid != null) returnWebpage.properties.redirect = {
+			type: "item",
+			uuid: redirectValue.uuid,
+			pageType: "item"
 		};
 	}
 	if (imageLink != null) returnWebpage.properties.backgroundImage = {
@@ -1127,14 +1139,14 @@ function parseWebBlock(blockResource, options, context) {
 * @param properties - Array of raw website properties in OCHRE format
 * @returns Parsed WebsiteProperties object
 */
-function parseWebsiteProperties(properties, websiteTree, sidebar, options) {
+function parseWebsiteProperties(properties, websiteTree, sidebar, options, parent) {
 	const websiteReader = websitePresentationReader(parseSimplifiedProperties({ property: properties }, options)).nested("presentation");
 	const returnProperties = {
-		type: websiteReader.valueOr("webUI", "traditional"),
-		status: websiteReader.valueOr("status", "development"),
-		versionLabel: websiteReader.valueOr("version-label", "release"),
-		privacy: websiteReader.valueOr("privacy", "public"),
-		contact: null,
+		type: websiteReader.valueOr("webUI", parent?.type ?? "traditional"),
+		status: websiteReader.valueOr("status", parent?.status ?? "development"),
+		versionLabel: websiteReader.valueOr("version-label", parent?.versionLabel ?? "release"),
+		privacy: websiteReader.valueOr("privacy", parent?.privacy ?? "public"),
+		contact: parent?.contact ?? null,
 		loadingVariant: "spinner",
 		theme: {
 			isThemeToggleDisplayed: true,
@@ -1151,33 +1163,33 @@ function parseWebsiteProperties(properties, websiteTree, sidebar, options) {
 			alignment: "start",
 			isProjectDisplayed: true,
 			searchBarBoundElementUuid: null,
-			items: null
+			items: parent?.navbar.items ?? null
 		},
 		footer: {
 			isDisplayed: true,
 			logoUuid: null,
-			items: null
+			items: parent?.footer.items ?? null
 		},
-		sidebar,
+		sidebar: sidebar ?? parent?.sidebar ?? null,
 		itemPage: {
-			isMainContentDisplayed: true,
-			isDescriptionDisplayed: true,
-			isDocumentDisplayed: true,
-			isNotesDisplayed: true,
-			isEventsDisplayed: true,
-			isPeriodsDisplayed: true,
-			isPropertiesDisplayed: true,
-			isBibliographyDisplayed: true,
-			isPropertyValuesGrouped: true,
-			isPublicationDateTimeDisplayed: true,
-			isPersistentIdentifierDisplayed: true,
-			iiifViewer: "universal-viewer"
+			isMainContentDisplayed: parent?.itemPage.isMainContentDisplayed ?? true,
+			isDescriptionDisplayed: parent?.itemPage.isDescriptionDisplayed ?? true,
+			isDocumentDisplayed: parent?.itemPage.isDocumentDisplayed ?? true,
+			isNotesDisplayed: parent?.itemPage.isNotesDisplayed ?? true,
+			isEventsDisplayed: parent?.itemPage.isEventsDisplayed ?? true,
+			isPeriodsDisplayed: parent?.itemPage.isPeriodsDisplayed ?? true,
+			isPropertiesDisplayed: parent?.itemPage.isPropertiesDisplayed ?? true,
+			isBibliographyDisplayed: parent?.itemPage.isBibliographyDisplayed ?? true,
+			isPropertyValuesGrouped: parent?.itemPage.isPropertyValuesGrouped ?? true,
+			isPublicationDateTimeDisplayed: parent?.itemPage.isPublicationDateTimeDisplayed ?? true,
+			isPersistentIdentifierDisplayed: parent?.itemPage.isPersistentIdentifierDisplayed ?? true,
+			iiifViewer: parent?.itemPage.iiifViewer ?? "universal-viewer"
 		},
 		options: {
-			contextTree: null,
-			scopes: null,
-			labels: { title: null },
-			stylesheets: { properties: [] }
+			contextTree: parent?.options.contextTree ?? null,
+			scopes: parent?.options.scopes ?? null,
+			labels: { title: parent?.options.labels.title ?? null },
+			stylesheets: { properties: parent?.options.stylesheets.properties ?? [] }
 		}
 	};
 	const contactProperty = websiteReader.property("contact");
@@ -1189,41 +1201,44 @@ function parseWebsiteProperties(properties, websiteTree, sidebar, options) {
 		};
 		else throw new Error(`Contact property must use “name;email”, got “${contactProperty.values[0]?.content}” (website uuid “${websiteTree.uuid}”)`, { cause: websiteTree });
 	}
-	returnProperties.loadingVariant = websiteReader.valueOr("loading-variant", "spinner");
-	returnProperties.theme.isThemeToggleDisplayed = websiteReader.valueOr("supports-theme-toggle", true);
-	returnProperties.theme.defaultTheme = websiteReader.valueOr("default-theme", "system");
-	returnProperties.icon.logoUuid = websiteReader.uuid("navbar-logo");
-	returnProperties.icon.faviconUuid = websiteReader.uuid("favicon-ico");
-	returnProperties.icon.appleTouchIconUuid = websiteReader.uuid("favicon-img");
-	returnProperties.navbar.isDisplayed = websiteReader.valueOr("navbar-displayed", true);
-	returnProperties.navbar.variant = websiteReader.valueOr("navbar-variant", "default");
-	returnProperties.navbar.alignment = websiteReader.valueOr("navbar-alignment", "start");
-	returnProperties.navbar.isProjectDisplayed = websiteReader.valueOr("navbar-project-displayed", true);
-	returnProperties.navbar.searchBarBoundElementUuid = websiteReader.uuid("bound-element-navbar-search-bar");
-	returnProperties.footer.isDisplayed = websiteReader.valueOr("footer-displayed", true);
-	returnProperties.footer.logoUuid = websiteReader.uuid("footer-logo");
+	returnProperties.loadingVariant = websiteReader.valueOr("loading-variant", parent?.loadingVariant ?? "spinner");
+	returnProperties.theme.isThemeToggleDisplayed = websiteReader.valueOr("supports-theme-toggle", parent?.theme.isThemeToggleDisplayed ?? true);
+	returnProperties.theme.defaultTheme = websiteReader.valueOr("default-theme", parent?.theme.defaultTheme ?? "system");
+	returnProperties.icon.logoUuid = websiteReader.uuid("navbar-logo") ?? parent?.icon.logoUuid ?? null;
+	returnProperties.icon.faviconUuid = websiteReader.uuid("favicon-ico") ?? parent?.icon.faviconUuid ?? null;
+	returnProperties.icon.appleTouchIconUuid = websiteReader.uuid("favicon-img") ?? parent?.icon.appleTouchIconUuid ?? null;
+	returnProperties.navbar.isDisplayed = websiteReader.valueOr("navbar-displayed", parent?.navbar.isDisplayed ?? true);
+	returnProperties.navbar.variant = websiteReader.valueOr("navbar-variant", parent?.navbar.variant ?? "default");
+	returnProperties.navbar.alignment = websiteReader.valueOr("navbar-alignment", parent?.navbar.alignment ?? "start");
+	returnProperties.navbar.isProjectDisplayed = websiteReader.valueOr("navbar-project-displayed", parent?.navbar.isProjectDisplayed ?? true);
+	returnProperties.navbar.searchBarBoundElementUuid = websiteReader.uuid("bound-element-navbar-search-bar") ?? parent?.navbar.searchBarBoundElementUuid ?? null;
+	returnProperties.footer.isDisplayed = websiteReader.valueOr("footer-displayed", parent?.footer.isDisplayed ?? true);
+	returnProperties.footer.logoUuid = websiteReader.uuid("footer-logo") ?? parent?.footer.logoUuid ?? null;
 	const itemPageReader = websiteReader.nestedByValue("page-type", "item-page");
 	if (itemPageReader.size > 0) {
-		returnProperties.itemPage.isMainContentDisplayed = itemPageReader.valueOr("item-page-main-content-displayed", true);
-		returnProperties.itemPage.isDescriptionDisplayed = itemPageReader.valueOr("item-page-description-displayed", true);
-		returnProperties.itemPage.isDocumentDisplayed = itemPageReader.valueOr("item-page-document-displayed", true);
-		returnProperties.itemPage.isNotesDisplayed = itemPageReader.valueOr("item-page-notes-displayed", true);
-		returnProperties.itemPage.isEventsDisplayed = itemPageReader.valueOr("item-page-events-displayed", true);
-		returnProperties.itemPage.isPeriodsDisplayed = itemPageReader.valueOr("item-page-periods-displayed", true);
-		returnProperties.itemPage.isPropertiesDisplayed = itemPageReader.valueOr("item-page-properties-displayed", true);
-		returnProperties.itemPage.isBibliographyDisplayed = itemPageReader.valueOr("item-page-bibliography-displayed", true);
-		returnProperties.itemPage.isPropertyValuesGrouped = itemPageReader.valueOr("item-page-property-values-grouped", true);
-		returnProperties.itemPage.isPublicationDateTimeDisplayed = itemPageReader.valueOr("item-page-publication-date-time-displayed", true);
-		returnProperties.itemPage.isPersistentIdentifierDisplayed = itemPageReader.valueOr("item-page-persistent-identifier-displayed", true);
-		returnProperties.itemPage.iiifViewer = itemPageReader.valueOr("item-page-iiif-viewer", "universal-viewer");
+		returnProperties.itemPage.isMainContentDisplayed = itemPageReader.valueOr("item-page-main-content-displayed", returnProperties.itemPage.isMainContentDisplayed);
+		returnProperties.itemPage.isDescriptionDisplayed = itemPageReader.valueOr("item-page-description-displayed", returnProperties.itemPage.isDescriptionDisplayed);
+		returnProperties.itemPage.isDocumentDisplayed = itemPageReader.valueOr("item-page-document-displayed", returnProperties.itemPage.isDocumentDisplayed);
+		returnProperties.itemPage.isNotesDisplayed = itemPageReader.valueOr("item-page-notes-displayed", returnProperties.itemPage.isNotesDisplayed);
+		returnProperties.itemPage.isEventsDisplayed = itemPageReader.valueOr("item-page-events-displayed", returnProperties.itemPage.isEventsDisplayed);
+		returnProperties.itemPage.isPeriodsDisplayed = itemPageReader.valueOr("item-page-periods-displayed", returnProperties.itemPage.isPeriodsDisplayed);
+		returnProperties.itemPage.isPropertiesDisplayed = itemPageReader.valueOr("item-page-properties-displayed", returnProperties.itemPage.isPropertiesDisplayed);
+		returnProperties.itemPage.isBibliographyDisplayed = itemPageReader.valueOr("item-page-bibliography-displayed", returnProperties.itemPage.isBibliographyDisplayed);
+		returnProperties.itemPage.isPropertyValuesGrouped = itemPageReader.valueOr("item-page-property-values-grouped", returnProperties.itemPage.isPropertyValuesGrouped);
+		returnProperties.itemPage.isPublicationDateTimeDisplayed = itemPageReader.valueOr("item-page-publication-date-time-displayed", returnProperties.itemPage.isPublicationDateTimeDisplayed);
+		returnProperties.itemPage.isPersistentIdentifierDisplayed = itemPageReader.valueOr("item-page-persistent-identifier-displayed", returnProperties.itemPage.isPersistentIdentifierDisplayed);
+		returnProperties.itemPage.iiifViewer = itemPageReader.valueOr("item-page-iiif-viewer", returnProperties.itemPage.iiifViewer);
 	}
 	if (websiteTree.options != null) {
 		const parsedOptions = parseWebsiteOptions(websiteTree.options, options);
-		returnProperties.options.scopes = parsedOptions.scopes;
-		returnProperties.options.contextTree = parsedOptions.contextTree;
-		returnProperties.options.labels = parsedOptions.labels;
+		returnProperties.options.scopes = (parsedOptions.scopes != null && parsedOptions.scopes.length > 0 ? parsedOptions : returnProperties.options).scopes;
+		returnProperties.options.contextTree = parsedOptions.contextTree ?? returnProperties.options.contextTree;
+		returnProperties.options.labels = { title: parsedOptions.labels.title ?? returnProperties.options.labels.title };
+	}
+	if ("styleOptions" in websiteTree && websiteTree.styleOptions != null) {
+		const stylesheetProperties = parseStylesheets(websiteTree.styleOptions.style);
+		if (stylesheetProperties.length > 0) returnProperties.options.stylesheets.properties = stylesheetProperties;
 	}
-	if ("styleOptions" in websiteTree && websiteTree.styleOptions != null) returnProperties.options.stylesheets.properties = parseStylesheets(websiteTree.styleOptions.style);
 	return returnProperties;
 }
 function parseContextItem(contextItemToParse, options) {
@@ -1303,7 +1318,8 @@ function parseWebsiteTree(websiteTree, context, type, options, slugPrefix) {
 		pageSlugsByUuid
 	};
 	const sidebar = parseSidebar(resources, options, treeContext);
-	const properties = parseWebsiteProperties(websiteTree.properties.property, websiteTree, sidebar, options);
+	const properties = parseWebsiteProperties(websiteTree.properties.property, websiteTree, sidebar, options, context.parentProperties ?? null);
+	const license = parseLicense(websiteTree.availability) ?? context.parentLicense ?? null;
 	return {
 		uuid: websiteTree.uuid,
 		type,
@@ -1312,8 +1328,12 @@ function parseWebsiteTree(websiteTree, context, type, options, slugPrefix) {
 		publicationDateTime: websiteTree.publicationDateTime ?? null,
 		identification: parseIdentification(websiteTree.identification, options),
 		creators: websiteTree.creators ? parsePersonList(websiteTree.creators.creator, options) : [],
-		license: parseLicense(websiteTree.availability),
-		items: parseWebpages(resources, options, treeContext, slugPrefix),
+		license,
+		items: parseWebpages(resources, options, {
+			...treeContext,
+			parentProperties: properties,
+			parentLicense: license
+		}, slugPrefix),
 		properties
 	};
 }

package/dist/types/website.d.mts

@@ -203,8 +203,17 @@ type Webpage<T extends LanguageCodes = LanguageCodes> = {
     isDisplayedInNavbar: boolean;
     isNavbarSearchBarDisplayed: boolean;
     redirect: {
+      type: "url";
       href: string;
       isExternal: boolean;
+    } | {
+      type: "page";
+      slug: string;
+      uuid: string;
+    } | {
+      type: "item";
+      uuid: string;
+      pageType: "item" | "entry";
     } | null;
     backgroundImage: WebImage<T> | null;
     sidebar: WebSidebar<T> | null;

package/package.json

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