@digitalculture/ochre-sdk 0.17.13 → 0.17.15

package/dist/index.d.mts

@@ -710,8 +710,14 @@ type Website = {
     defaultTheme: "light" | "dark" | null;
     logoUrl: string | null;
     itemPage: {
-      iiifViewer: "universal-viewer" | "clover";
+      isMainContentDisplayed: boolean;
+      isDescriptionDisplayed: boolean;
+      isDocumentDisplayed: boolean;
+      isNotesDisplayed: boolean;
+      isPropertiesDisplayed: boolean;
+      isBibliographyDisplayed: boolean;
       isPropertyValuesGrouped: boolean;
+      iiifViewer: "universal-viewer" | "clover";
     };
     options: {
       contexts: PropertyContexts | null;
@@ -725,6 +731,7 @@ type Website = {
 type Webpage = {
   title: string;
   slug: string;
+  publicationDateTime: Date | null;
   properties: {
     displayedInHeader: boolean;
     width: "full" | "large" | "narrow" | "default";
@@ -950,7 +957,7 @@ type WebElementComponent = {
   timelineId: string;
 } | {
   component: "video";
-  isChaptersDislayed: boolean;
+  isChaptersDisplayed: boolean;
 };
 /**
  * Represents an image used in web elements

package/dist/index.mjs

@@ -1,4 +1,6 @@
 import * as z from "zod";
+import { UTCDate } from "@date-fns/utc";
+import { parseISO, set } from "date-fns";
 
 //#region src/utils/internal.ts
 /**
@@ -1116,7 +1118,7 @@ function parseMetadata(metadata) {
 function parseContextItem(contextItem) {
 	return {
 		uuid: contextItem.uuid,
-		publicationDateTime: contextItem.publicationDateTime != null ? new Date(contextItem.publicationDateTime) : null,
+		publicationDateTime: contextItem.publicationDateTime != null ? parseISO(contextItem.publicationDateTime) : null,
 		number: contextItem.n,
 		content: parseFakeString(contextItem.content)
 	};
@@ -1169,7 +1171,7 @@ function parsePerson(person, metadata, persistentUrl, belongsTo) {
 		category: "person",
 		belongsTo: belongsTo ?? null,
 		metadata: metadata ?? null,
-		publicationDateTime: person.publicationDateTime != null ? new Date(person.publicationDateTime) : null,
+		publicationDateTime: person.publicationDateTime != null ? parseISO(person.publicationDateTime) : null,
 		persistentUrl: persistentUrl ?? null,
 		type: person.type ?? null,
 		number: person.n ?? null,
@@ -1228,7 +1230,7 @@ function parseLink(linkRaw) {
 			description: "description" in link && link.description != null ? parseStringContent(link.description) : null,
 			image: null,
 			bibliographies: "bibliography" in linkRaw ? parseBibliographies(Array.isArray(linkRaw.bibliography) ? linkRaw.bibliography : [linkRaw.bibliography]) : null,
-			publicationDateTime: link.publicationDateTime != null ? new Date(link.publicationDateTime) : null
+			publicationDateTime: link.publicationDateTime != null ? parseISO(link.publicationDateTime) : null
 		};
 		if ("height" in link && link.height != null && link.width != null && link.heightPreview != null && link.widthPreview != null) returnLink.image = {
 			isInline: link.rend === "inline",
@@ -1278,7 +1280,7 @@ function parseDocument(document, language = "eng") {
 */
 function parseImage(image) {
 	return {
-		publicationDateTime: image.publicationDateTime != null ? new Date(image.publicationDateTime) : null,
+		publicationDateTime: image.publicationDateTime != null ? parseISO(image.publicationDateTime) : null,
 		identification: image.identification ? parseIdentification(image.identification) : null,
 		url: image.href ?? (image.htmlImgSrcPrefix == null && image.content != null ? parseFakeString(image.content) : null),
 		htmlPrefix: image.htmlImgSrcPrefix ?? null,
@@ -1424,17 +1426,17 @@ function parseObservations(observations) {
 function parseEvents(events) {
 	const returnEvents = [];
 	for (const event of events) returnEvents.push({
-		dateTime: event.dateTime != null ? new Date(event.dateTime) : null,
+		dateTime: event.dateTime != null ? parseISO(event.dateTime) : null,
 		date: event.partialDates?.year != null ? `${event.partialDates.year}-01-01/${event.partialDates.endYear ?? event.partialDates.year}-12-31` : null,
 		label: parseStringContent(event.label),
 		location: event.location ? {
 			uuid: event.location.uuid,
-			publicationDateTime: event.location.publicationDateTime != null ? new Date(event.location.publicationDateTime) : null,
+			publicationDateTime: event.location.publicationDateTime != null ? parseISO(event.location.publicationDateTime) : null,
 			content: parseStringContent(event.location)
 		} : null,
 		agent: event.agent ? {
 			uuid: event.agent.uuid,
-			publicationDateTime: event.agent.publicationDateTime != null ? new Date(event.agent.publicationDateTime) : null,
+			publicationDateTime: event.agent.publicationDateTime != null ? parseISO(event.agent.publicationDateTime) : null,
 			content: parseStringContent(event.agent)
 		} : null,
 		comment: event.comment ? parseStringContent(event.comment) : null,
@@ -1524,7 +1526,7 @@ function parseProperty(property, language = "eng") {
 				category: value.category ?? null,
 				type: value.type ?? null,
 				uuid: value.uuid ?? null,
-				publicationDateTime: value.publicationDateTime != null ? new Date(value.publicationDateTime) : null,
+				publicationDateTime: value.publicationDateTime != null ? parseISO(value.publicationDateTime) : null,
 				unit: value.unit ?? null,
 				height: value.height ?? null,
 				width: value.width ?? null,
@@ -1586,7 +1588,7 @@ function parseImageMap(imageMap) {
 	const imageMapAreasToParse = Array.isArray(imageMap.area) ? imageMap.area : [imageMap.area];
 	for (const area of imageMapAreasToParse) returnImageMap.area.push({
 		uuid: area.uuid,
-		publicationDateTime: area.publicationDateTime != null ? new Date(area.publicationDateTime) : null,
+		publicationDateTime: area.publicationDateTime != null ? parseISO(area.publicationDateTime) : null,
 		category: area.type,
 		title: parseFakeString(area.title),
 		shape: area.shape === "rect" ? "rectangle" : area.shape === "circle" ? "circle" : "polygon",
@@ -1607,7 +1609,7 @@ function parsePeriod(period, metadata, persistentUrl, belongsTo) {
 		category: "period",
 		belongsTo: belongsTo ?? null,
 		metadata: metadata ?? null,
-		publicationDateTime: period.publicationDateTime != null ? new Date(period.publicationDateTime) : null,
+		publicationDateTime: period.publicationDateTime != null ? parseISO(period.publicationDateTime) : null,
 		persistentUrl: persistentUrl ?? null,
 		type: period.type ?? null,
 		number: period.n ?? null,
@@ -1640,7 +1642,7 @@ function parseBibliography(bibliography, metadata, persistentUrl, belongsTo) {
 		for (const resource of resourcesToParse) sourceResources.push({
 			uuid: resource.uuid,
 			category: "resource",
-			publicationDateTime: new Date(resource.publicationDateTime),
+			publicationDateTime: parseISO(resource.publicationDateTime),
 			type: resource.type,
 			identification: parseIdentification(resource.identification),
 			href: resource.href ?? null
@@ -1664,7 +1666,7 @@ function parseBibliography(bibliography, metadata, persistentUrl, belongsTo) {
 		zoteroId: bibliography.zoteroId ?? null,
 		category: "bibliography",
 		metadata: metadata ?? null,
-		publicationDateTime: bibliography.publicationDateTime != null ? new Date(bibliography.publicationDateTime) : null,
+		publicationDateTime: bibliography.publicationDateTime != null ? parseISO(bibliography.publicationDateTime) : null,
 		persistentUrl: persistentUrl ?? null,
 		type: bibliography.type ?? null,
 		number: bibliography.n ?? null,
@@ -1680,7 +1682,11 @@ function parseBibliography(bibliography, metadata, persistentUrl, belongsTo) {
 		},
 		publicationInfo: {
 			publishers: bibliography.publicationInfo?.publishers ? parsePersons(Array.isArray(bibliography.publicationInfo.publishers.publishers.person) ? bibliography.publicationInfo.publishers.publishers.person : [bibliography.publicationInfo.publishers.publishers.person]) : [],
-			startDate: bibliography.publicationInfo?.startDate ? new Date(bibliography.publicationInfo.startDate.year, bibliography.publicationInfo.startDate.month, bibliography.publicationInfo.startDate.day) : null
+			startDate: bibliography.publicationInfo?.startDate ? set(new UTCDate(0, 0, 0, 0, 0, 0, 0), {
+				year: bibliography.publicationInfo.startDate.year,
+				month: bibliography.publicationInfo.startDate.month,
+				date: bibliography.publicationInfo.startDate.day
+			}) : null
 		},
 		entryInfo: bibliography.entryInfo ? {
 			startIssue: parseFakeString(bibliography.entryInfo.startIssue),
@@ -1718,7 +1724,7 @@ function parsePropertyValue(propertyValue, metadata, persistentUrl, belongsTo) {
 		belongsTo: belongsTo ?? null,
 		metadata: metadata ?? null,
 		number: propertyValue.n,
-		publicationDateTime: propertyValue.publicationDateTime ? new Date(propertyValue.publicationDateTime) : null,
+		publicationDateTime: propertyValue.publicationDateTime ? parseISO(propertyValue.publicationDateTime) : null,
 		persistentUrl: persistentUrl ?? null,
 		context: propertyValue.context ? parseContext(propertyValue.context) : null,
 		availability: propertyValue.availability ? parseLicense(propertyValue.availability) : null,
@@ -1754,7 +1760,7 @@ function parseText(text, metadata, persistentUrl, belongsTo) {
 		category: "text",
 		belongsTo: belongsTo ?? null,
 		metadata: metadata ?? null,
-		publicationDateTime: text.publicationDateTime ? new Date(text.publicationDateTime) : null,
+		publicationDateTime: text.publicationDateTime ? parseISO(text.publicationDateTime) : null,
 		persistentUrl: persistentUrl ?? null,
 		type: text.type ?? null,
 		language: text.language ?? null,
@@ -1883,7 +1889,7 @@ function parseTree(tree, itemCategories, metadata, persistentUrl, belongsTo) {
 		category: "tree",
 		belongsTo: belongsTo ?? null,
 		metadata: metadata ?? null,
-		publicationDateTime: new Date(tree.publicationDateTime),
+		publicationDateTime: parseISO(tree.publicationDateTime),
 		persistentUrl: persistentUrl ?? null,
 		identification: parseIdentification(tree.identification),
 		creators,
@@ -1957,7 +1963,7 @@ function parseSet(set, itemCategories, metadata, persistentUrl, belongsTo) {
 		belongsTo: belongsTo ?? null,
 		metadata: metadata ?? null,
 		itemCategories: parsedItemCategories,
-		publicationDateTime: set.publicationDateTime ? new Date(set.publicationDateTime) : null,
+		publicationDateTime: set.publicationDateTime ? parseISO(set.publicationDateTime) : null,
 		persistentUrl: persistentUrl ?? null,
 		date: set.date ?? null,
 		license: parseLicense(set.availability),
@@ -1997,7 +2003,7 @@ function parseResource(resource, metadata, persistentUrl, belongsTo) {
 		category: "resource",
 		belongsTo: belongsTo ?? null,
 		metadata: metadata ?? null,
-		publicationDateTime: resource.publicationDateTime ? new Date(resource.publicationDateTime) : null,
+		publicationDateTime: resource.publicationDateTime ? parseISO(resource.publicationDateTime) : null,
 		persistentUrl: persistentUrl ?? null,
 		type: resource.type,
 		number: resource.n,
@@ -2053,7 +2059,7 @@ function parseSpatialUnit(spatialUnit, metadata, persistentUrl, belongsTo) {
 		category: "spatialUnit",
 		belongsTo: belongsTo ?? null,
 		metadata: metadata ?? null,
-		publicationDateTime: spatialUnit.publicationDateTime != null ? new Date(spatialUnit.publicationDateTime) : null,
+		publicationDateTime: spatialUnit.publicationDateTime != null ? parseISO(spatialUnit.publicationDateTime) : null,
 		persistentUrl: persistentUrl ?? null,
 		number: spatialUnit.n,
 		context: "context" in spatialUnit && spatialUnit.context ? parseContext(spatialUnit.context) : null,
@@ -2097,7 +2103,7 @@ function parseConcept(concept, metadata, persistentUrl, belongsTo) {
 		category: "concept",
 		belongsTo: belongsTo ?? null,
 		metadata: metadata ?? null,
-		publicationDateTime: concept.publicationDateTime ? new Date(concept.publicationDateTime) : null,
+		publicationDateTime: concept.publicationDateTime ? parseISO(concept.publicationDateTime) : null,
 		persistentUrl: persistentUrl ?? null,
 		number: concept.n,
 		license: "availability" in concept && concept.availability ? parseLicense(concept.availability) : null,
@@ -2645,10 +2651,10 @@ function parseWebElementProperties(componentProperty, elementResource) {
 		case "video": {
 			const videoLink = links.find((link) => link.type === "video");
 			if (!videoLink) throw new Error(`Video link not found for the following component: “${componentName}”`);
-			let isChaptersDislayed = getPropertyValueByLabel(componentProperty.properties, "chapters-displayed");
-			isChaptersDislayed ??= true;
+			let isChaptersDisplayed = getPropertyValueByLabel(componentProperty.properties, "chapters-displayed");
+			isChaptersDisplayed ??= true;
 			properties.videoId = videoLink.uuid;
-			properties.isChaptersDislayed = isChaptersDislayed === true;
+			properties.isChaptersDisplayed = isChaptersDisplayed === true;
 			break;
 		}
 		default:
@@ -2821,6 +2827,7 @@ function parseWebpage(webpageResource) {
 	return {
 		title: identification.label,
 		slug,
+		publicationDateTime: webpageResource.publicationDateTime ? parseISO(webpageResource.publicationDateTime) : null,
 		items,
 		properties: {
 			displayedInHeader,
@@ -3163,10 +3170,16 @@ function parseWebsiteProperties(properties, websiteTree) {
 	let isHeaderProjectDisplayed = true;
 	let isFooterDisplayed = true;
 	let isSidebarDisplayed = false;
-	let iiifViewer = "universal-viewer";
-	let isPropertyValuesGrouped = true;
 	let supportsThemeToggle = true;
 	let defaultTheme = null;
+	let isMainContentDisplayed = true;
+	let isDescriptionDisplayed = true;
+	let isDocumentDisplayed = true;
+	let isNotesDisplayed = true;
+	let isPropertiesDisplayed = true;
+	let isBibliographyDisplayed = true;
+	let isPropertyValuesGrouped = true;
+	let iiifViewer = "universal-viewer";
 	const headerProperty = websiteProperties.find((property) => property.label === "navbar-displayed")?.values[0];
 	if (headerProperty) isHeaderDisplayed = headerProperty.content === true;
 	const headerVariantProperty = websiteProperties.find((property) => property.label === "navbar-variant")?.values[0];
@@ -3180,10 +3193,25 @@ function parseWebsiteProperties(properties, websiteTree) {
 	const sidebarProperty = websiteProperties.find((property) => property.label === "sidebar-displayed")?.values[0];
 	if (sidebarProperty) isSidebarDisplayed = sidebarProperty.content === true;
 	const headerSearchBarBoundElementUuid = websiteProperties.find((property) => property.label === "bound-element-navbar-search-bar")?.values[0]?.uuid ?? null;
-	const iiifViewerProperty = websiteProperties.find((property) => property.label === "iiif-viewer")?.values[0];
-	if (iiifViewerProperty) iiifViewer = iiifViewerProperty.content;
-	const isPropertyValuesGroupedProperty = websiteProperties.find((property) => property.label === "is-property-values-grouped")?.values[0];
-	if (isPropertyValuesGroupedProperty) isPropertyValuesGrouped = isPropertyValuesGroupedProperty.content === true;
+	const itemPageTypeProperty = websiteProperties.find((property) => property.label === "page-type" && property.values[0]?.content === "item-page");
+	if (itemPageTypeProperty) {
+		const isItemPageMainContentDisplayedProperty = itemPageTypeProperty.properties.find((property) => property.label === "item-page-main-content-displayed")?.values[0];
+		if (isItemPageMainContentDisplayedProperty) isMainContentDisplayed = isItemPageMainContentDisplayedProperty.content === true;
+		const isItemPageDescriptionDisplayedProperty = itemPageTypeProperty.properties.find((property) => property.label === "item-page-description-displayed")?.values[0];
+		if (isItemPageDescriptionDisplayedProperty) isDescriptionDisplayed = isItemPageDescriptionDisplayedProperty.content === true;
+		const isItemPageDocumentDisplayedProperty = itemPageTypeProperty.properties.find((property) => property.label === "item-page-document-displayed")?.values[0];
+		if (isItemPageDocumentDisplayedProperty) isDocumentDisplayed = isItemPageDocumentDisplayedProperty.content === true;
+		const isItemPageNotesDisplayedProperty = itemPageTypeProperty.properties.find((property) => property.label === "item-page-notes-displayed")?.values[0];
+		if (isItemPageNotesDisplayedProperty) isNotesDisplayed = isItemPageNotesDisplayedProperty.content === true;
+		const isItemPagePropertiesDisplayedProperty = itemPageTypeProperty.properties.find((property) => property.label === "item-page-properties-displayed")?.values[0];
+		if (isItemPagePropertiesDisplayedProperty) isPropertiesDisplayed = isItemPagePropertiesDisplayedProperty.content === true;
+		const isItemPageBibliographyDisplayedProperty = itemPageTypeProperty.properties.find((property) => property.label === "item-page-bibliography-displayed")?.values[0];
+		if (isItemPageBibliographyDisplayedProperty) isBibliographyDisplayed = isItemPageBibliographyDisplayedProperty.content === true;
+		const isItemPagePropertyValuesGroupedProperty = itemPageTypeProperty.properties.find((property) => property.label === "item-page-property-values-grouped")?.values[0];
+		if (isItemPagePropertyValuesGroupedProperty) isPropertyValuesGrouped = isItemPagePropertyValuesGroupedProperty.content === true;
+		const isItemPageIiifViewerProperty = itemPageTypeProperty.properties.find((property) => property.label === "item-page-iiif-viewer")?.values[0];
+		if (isItemPageIiifViewerProperty) iiifViewer = isItemPageIiifViewerProperty.content;
+	}
 	const supportsThemeToggleProperty = websiteProperties.find((property) => property.label === "supports-theme-toggle")?.values[0];
 	if (supportsThemeToggleProperty) supportsThemeToggle = supportsThemeToggleProperty.content === true;
 	const defaultThemeProperty = websiteProperties.find((property) => property.label === "default-theme")?.values[0];
@@ -3232,8 +3260,14 @@ function parseWebsiteProperties(properties, websiteTree) {
 		defaultTheme,
 		logoUrl: logoUuid !== null ? `https://ochre.lib.uchicago.edu/ochre?uuid=${logoUuid}&load` : null,
 		itemPage: {
-			iiifViewer,
-			isPropertyValuesGrouped
+			isMainContentDisplayed,
+			isDescriptionDisplayed,
+			isDocumentDisplayed,
+			isNotesDisplayed,
+			isPropertiesDisplayed,
+			isBibliographyDisplayed,
+			isPropertyValuesGrouped,
+			iiifViewer
 		},
 		options: {
 			contexts,
@@ -3287,7 +3321,7 @@ function parseWebsite(websiteTree, metadata, belongsTo, { version = DEFAULT_API_
 		version,
 		belongsTo: belongsTo ?? null,
 		metadata: parseMetadata(metadata),
-		publicationDateTime: websiteTree.publicationDateTime ? new Date(websiteTree.publicationDateTime) : null,
+		publicationDateTime: websiteTree.publicationDateTime ? parseISO(websiteTree.publicationDateTime) : null,
 		identification: parseIdentification(websiteTree.identification),
 		creators: websiteTree.creators ? parsePersons(Array.isArray(websiteTree.creators.creator) ? websiteTree.creators.creator : [websiteTree.creators.creator]) : [],
 		license: parseLicense(websiteTree.availability),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.17.13",
+  "version": "0.17.15",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -40,6 +40,8 @@
     "dist"
   ],
   "dependencies": {
+    "@date-fns/utc": "^2.1.1",
+    "date-fns": "^4.1.0",
     "zod": "^4.3.6"
   },
   "devDependencies": {