@digitalculture/ochre-sdk 0.14.8 → 0.14.10

package/dist/index.d.mts

@@ -132,6 +132,10 @@ type Image = {
   width: number | null;
   height: number | null;
 };
+/**
+ * Represents a file format
+ */
+type FileFormat = "image/jpeg" | "image/gif" | "image/tiff" | "image/bmp" | "image/png" | "image/svg+xml" | "image/jpeg-imageMap" | "image/gif-imageMap" | "image/tiff-imageMap" | "image/bmp-imageMap" | "image/png-imageMap" | "image/svg+xml-imageMap" | "video/mpeg" | "video/mp4" | "video/quicktime" | "video/x-msvideo" | "video/x-ms-wmv" | "video/x-ms-asf" | "drawing/dwg" | "audio/aiff" | "audio/basic" | "audio/midi" | "audio/mp4" | "audio/mpeg" | "audio/x-ms-wax" | "audio/x-ms-wma" | "audio/wav" | "text/pdf" | "text/doc" | "text/ppt" | "text/html" | "text/plain" | "application/xls" | "application/xlsx" | "application/ai" | "application/octet-stream" | "application/iiif" | "image/fits" | "image/ptm" | "model/obj";
 /**
  * Represents a link to another item with optional image and bibliographic references
  */
@@ -144,7 +148,7 @@ type Link = {
   description: string | null;
   content: string | null;
   href: string | null;
-  fileFormat: string | null;
+  fileFormat: FileFormat | null;
   fileSize: number | null;
   image: {
     isInline: boolean;
@@ -247,17 +251,25 @@ type Observation = {
  * Represents an event with date, label and optional agent
  */
 type Event = {
-  date: Date | null;
+  dateTime: Date | null;
+  date: string | null;
   label: string;
   agent: {
     uuid: string;
+    publicationDateTime: Date | null;
     content: string;
   } | null;
   location: {
     uuid: string;
+    publicationDateTime: Date | null;
     content: string;
   } | null;
   comment: string | null;
+  other: {
+    uuid: string | null;
+    category: string | null;
+    content: string;
+  } | null;
   value: string | null;
 };
 /**
@@ -293,7 +305,7 @@ type Resource = {
   coordinates: Array<Coordinate>;
   document: string | null;
   href: string | null;
-  fileFormat: string | null;
+  fileFormat: FileFormat | null;
   fileSize: number | null;
   imageMap: ImageMap | null;
   periods: Array<Period>;
@@ -710,7 +722,7 @@ type WebElementComponent = {
 } | {
   component: "annotated-image";
   imageUuid: string;
-  isFilterDisplayed: boolean;
+  isFilterInputDisplayed: boolean;
   isOptionsDisplayed: boolean;
   isAnnotationHighlightsDisplayed: boolean;
   isAnnotationTooltipsDisplayed: boolean;
@@ -730,7 +742,7 @@ type WebElementComponent = {
   component: "entries";
   entriesId: string;
   variant: "entry" | "item";
-  isFilterDisplayed: boolean;
+  isFilterInputDisplayed: boolean;
 } | {
   component: "button";
   variant: "default" | "transparent" | "link";
@@ -811,7 +823,7 @@ type WebElementComponent = {
 } | {
   component: "image-gallery";
   galleryId: string;
-  isFilterDisplayed: boolean;
+  isFilterInputDisplayed: boolean;
 } | {
   component: "map";
   mapId: string;
@@ -1286,4 +1298,4 @@ declare function filterProperties(property: Property, filter: {
   value: string | number | boolean | Date;
 }, options?: PropertyOptions): boolean;
 //#endregion
-export { Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, Data, DataCategory, Event, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyQueryItem, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Section, Set, SpatialUnit, Style, Text, Tree, UuidMetadata, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebTitle, Webpage, Website, fetchByUuidMetadata, fetchGallery, fetchItem, fetchPropertyQuery, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyQueryItem, PropertyValue, PropertyValueContent, PropertyValueContentType, Resource, Section, Set, SpatialUnit, Style, Text, Tree, UuidMetadata, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebTitle, Webpage, Website, fetchByUuidMetadata, fetchGallery, fetchItem, fetchPropertyQuery, fetchWebsite, filterProperties, getPropertyByLabel, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/dist/index.mjs

@@ -1174,17 +1174,25 @@ function parseObservations(observations) {
 function parseEvents(events) {
 	const returnEvents = [];
 	for (const event of events) returnEvents.push({
-		date: event.dateTime != null ? new Date(event.dateTime) : null,
+		dateTime: event.dateTime != null ? new Date(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,
 			content: parseStringContent(event.location)
 		} : null,
 		agent: event.agent ? {
 			uuid: event.agent.uuid,
+			publicationDateTime: event.agent.publicationDateTime != null ? new Date(event.agent.publicationDateTime) : null,
 			content: parseStringContent(event.agent)
 		} : null,
 		comment: event.comment ? parseStringContent(event.comment) : null,
+		other: event.other != null ? {
+			uuid: event.other.uuid ?? null,
+			category: event.other.category ?? null,
+			content: parseStringContent(event.other)
+		} : null,
 		value: event.value ? parseFakeString(event.value) : null
 	});
 	return returnEvents;
@@ -1899,12 +1907,12 @@ function parseWebElementProperties(componentProperty, elementResource) {
 		case "annotated-image": {
 			const imageLinks = links.filter((link) => link.type === "image" || link.type === "IIIF");
 			if (imageLinks.length === 0) throw new Error(`Image link not found for the following component: “${componentName}”`);
-			const isFilterDisplayed = getPropertyValueByLabel(componentProperty.properties, "filter-displayed") === true;
+			const isFilterInputDisplayed = getPropertyValueByLabel(componentProperty.properties, "filter-input-displayed") === true;
 			const isOptionsDisplayed = getPropertyValueByLabel(componentProperty.properties, "options-displayed") !== false;
 			const isAnnotationHighlightsDisplayed = getPropertyValueByLabel(componentProperty.properties, "annotation-highlights-displayed") !== false;
 			const isAnnotationTooltipsDisplayed = getPropertyValueByLabel(componentProperty.properties, "annotation-tooltips-displayed") !== false;
 			properties.imageUuid = imageLinks[0].uuid;
-			properties.isFilterDisplayed = isFilterDisplayed;
+			properties.isFilterInputDisplayed = isFilterInputDisplayed;
 			properties.isOptionsDisplayed = isOptionsDisplayed;
 			properties.isAnnotationHighlightsDisplayed = isAnnotationHighlightsDisplayed;
 			properties.isAnnotationTooltipsDisplayed = isAnnotationTooltipsDisplayed;
@@ -2089,12 +2097,12 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			if (!entriesLink) throw new Error(`Entries link not found for the following component: “${componentName}”`);
 			let variant = getPropertyValueByLabel(componentProperty.properties, "variant");
 			variant ??= "entry";
-			let isFilterDisplayed = false;
-			const isFilterDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "filter-displayed");
-			if (isFilterDisplayedProperty !== null) isFilterDisplayed = isFilterDisplayedProperty === true;
+			let isFilterInputDisplayed = false;
+			const isFilterInputDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "filter-input-displayed");
+			if (isFilterInputDisplayedProperty !== null) isFilterInputDisplayed = isFilterInputDisplayedProperty === true;
 			properties.entriesId = entriesLink.uuid;
 			properties.variant = variant;
-			properties.isFilterDisplayed = isFilterDisplayed;
+			properties.isFilterInputDisplayed = isFilterInputDisplayed;
 			break;
 		}
 		case "iframe": {
@@ -2204,9 +2212,9 @@ function parseWebElementProperties(componentProperty, elementResource) {
 		case "image-gallery": {
 			const galleryLink = links.find((link) => link.category === "tree" || link.category === "set");
 			if (!galleryLink) throw new Error(`Image gallery link not found for the following component: “${componentName}”`);
-			const isFilterDisplayed = getPropertyValueByLabel(componentProperty.properties, "filter-displayed") === true;
+			const isFilterInputDisplayed = getPropertyValueByLabel(componentProperty.properties, "filter-input-displayed") === true;
 			properties.galleryId = galleryLink.uuid;
-			properties.isFilterDisplayed = isFilterDisplayed;
+			properties.isFilterInputDisplayed = isFilterInputDisplayed;
 			break;
 		}
 		case "map": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitalculture/ochre-sdk",
-  "version": "0.14.8",
+  "version": "0.14.10",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -49,7 +49,7 @@
     "eslint": "^9.39.2",
     "prettier": "^3.7.4",
     "terser": "^5.44.1",
-    "tsdown": "^0.18.2",
+    "tsdown": "^0.18.3",
     "typescript": "^5.9.3",
     "vitest": "^4.0.16"
   },