@digitalculture/ochre-sdk 0.14.7 → 0.14.9

package/dist/index.d.mts

@@ -162,7 +162,7 @@ type Link = {
 type ImageMapArea = {
   uuid: string;
   publicationDateTime: Date | null;
-  type: string;
+  category: string;
   title: string;
   shape: "rectangle" | "circle" | "polygon";
   coords: Array<number>;
@@ -247,17 +247,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;
 };
 /**
@@ -816,6 +824,8 @@ type WebElementComponent = {
   component: "map";
   mapId: string;
   customBasemap: string | null;
+  initialBounds: [[number, number], [number, number]] | null;
+  maximumBounds: [[number, number], [number, number]] | null;
   isControlsDisplayed: boolean;
   isInteractive: boolean;
   isClustered: boolean;

package/dist/index.mjs

@@ -151,6 +151,32 @@ const whitespaceSchema = z.string().transform((str) => str.split(" ")).pipe(z.ar
 * @internal
 */
 const emailSchema = z.email({ error: "Invalid email" });
+/**
+* Schema for parsing and validating a string in the format "[[number, number], [number, number]]"
+* into an array with exactly two bounds
+* @internal
+*/
+const boundsSchema = z.string().transform((str, ctx) => {
+	const trimmed = str.trim();
+	if (!trimmed.startsWith("[[") || !trimmed.endsWith("]]")) {
+		ctx.addIssue({
+			code: "invalid_format",
+			format: "string",
+			message: "String must start with '[[' and end with ']]'"
+		});
+		return z.NEVER;
+	}
+	try {
+		return JSON.parse(trimmed);
+	} catch {
+		ctx.addIssue({
+			code: "invalid_format",
+			format: "string",
+			message: "Invalid JSON format"
+		});
+		return z.NEVER;
+	}
+}).pipe(z.tuple([z.tuple([z.number(), z.number()]), z.tuple([z.number(), z.number()])], { message: "Must contain exactly 2 coordinate pairs" }));
 
 //#endregion
 //#region src/utils/getters.ts
@@ -1148,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;
@@ -1295,7 +1329,7 @@ function parseImageMap(imageMap) {
 	for (const area of imageMapAreasToParse) returnImageMap.area.push({
 		uuid: area.uuid,
 		publicationDateTime: area.publicationDateTime != null ? new Date(area.publicationDateTime) : null,
-		type: area.type,
+		category: area.type,
 		title: parseFakeString(area.title),
 		shape: area.shape === "rect" ? "rectangle" : area.shape === "circle" ? "circle" : "polygon",
 		coords: area.coords.split(",").map((coord) => Number.parseInt(coord)),
@@ -1822,6 +1856,11 @@ function parseConcepts(concepts) {
 	for (const concept of conceptsToParse) returnConcepts.push(parseConcept(concept));
 	return returnConcepts;
 }
+function parseBounds(bounds) {
+	const result = boundsSchema.safeParse(bounds);
+	if (!result.success) throw new Error(`Invalid bounds: ${result.error.message}`);
+	return result.data;
+}
 /**
 * Parses raw web element properties into a standardized WebElementComponent structure
 *
@@ -2193,6 +2232,12 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			let customBasemap = null;
 			const customBasemapProperty = getPropertyValueByLabel(componentProperty.properties, "custom-basemap");
 			if (customBasemapProperty !== null) customBasemap = customBasemapProperty;
+			let initialBounds = null;
+			const initialBoundsProperty = getPropertyValueByLabel(componentProperty.properties, "initial-bounds");
+			if (initialBoundsProperty !== null) initialBounds = parseBounds(String(initialBoundsProperty));
+			let maximumBounds = null;
+			const maximumBoundsProperty = getPropertyValueByLabel(componentProperty.properties, "maximum-bounds");
+			if (maximumBoundsProperty !== null) maximumBounds = parseBounds(String(maximumBoundsProperty));
 			let isControlsDisplayed = false;
 			const isControlsDisplayedProperty = getPropertyValueByLabel(componentProperty.properties, "controls-displayed");
 			if (isControlsDisplayedProperty !== null) isControlsDisplayed = isControlsDisplayedProperty === true;
@@ -2200,10 +2245,12 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			const isFullHeightProperty = getPropertyValueByLabel(componentProperty.properties, "is-full-height");
 			if (isFullHeightProperty !== null) isFullHeight = isFullHeightProperty === true;
 			properties.mapId = mapLink.uuid;
+			properties.customBasemap = customBasemap;
+			properties.initialBounds = initialBounds;
+			properties.maximumBounds = maximumBounds;
 			properties.isInteractive = isInteractive;
 			properties.isClustered = isClustered;
 			properties.isUsingPins = isUsingPins;
-			properties.customBasemap = customBasemap;
 			properties.isControlsDisplayed = isControlsDisplayed;
 			properties.isFullHeight = isFullHeight;
 			break;

package/package.json

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