ochre-sdk 1.0.53 → 1.0.55

package/dist/{utils.mjs → utilities.mjs}

@@ -1,5 +1,5 @@
 import * as v from "valibot";
-//#region src/utils.ts
+//#region src/utilities.ts
 const PSEUDO_UUID_REGEX = /^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$/i;
 function isRecord(value) {
 	return typeof value === "object" && value != null;
@@ -88,7 +88,7 @@ function appendDetailedError(lines, error, fallbackMessage, depth, seenErrors) {
 		}
 		if (error.cause != null) {
 			const causeLines = [];
-			if (appendDetailedCause(causeLines, error.cause, depth, seenErrors)) lines.push("", ...causeLines);
+			if (didAppendDetailedCause(causeLines, error.cause, depth, seenErrors)) lines.push("", ...causeLines);
 		}
 		return;
 	}
@@ -96,7 +96,7 @@ function appendDetailedError(lines, error, fallbackMessage, depth, seenErrors) {
 	const value = formatCauseValue(error);
 	if (value != null) lines.push(`${indent}Value: ${value}`);
 }
-function appendDetailedCause(lines, cause, depth, seenErrors) {
+function didAppendDetailedCause(lines, cause, depth, seenErrors) {
 	const indent = "  ".repeat(depth);
 	if (isSchemaValidationIssues(cause)) {
 		lines.push(`${indent}Schema validation`);
@@ -169,4 +169,4 @@ function flattenProperties(properties) {
 	return result;
 }
 //#endregion
-export { createSchemaValidationError, flattenProperties, getDetailedError, getErrorMessage, getErrorOutput, isPseudoUuid, stringLiteral };
+export { createSchemaValidationError, flattenProperties, getErrorOutput, isPseudoUuid, stringLiteral };

package/dist/xml/schemas.mjs

@@ -1,4 +1,4 @@
-import { isPseudoUuid } from "../utils.mjs";
+import { isPseudoUuid } from "../utilities.mjs";
 import * as v from "valibot";
 import { isValid, parseISO } from "date-fns";
 //#region src/xml/schemas.ts
@@ -58,10 +58,10 @@ const XMLContent = v.object({ content: v.array(v.object({
 }), "XMLContent: content is array of object with string, title, and lang") }, "XMLContent: Shape error");
 const XMLNumber = v.pipe(v.union([v.string("XMLNumber: string is string and required"), XMLString]), v.check(isXMLNumber, "XMLNumber: string is not a number"), v.transform(parseXMLNumber));
 const XMLOptionalNumber = v.optional(v.pipe(v.union([v.string("XMLNumber: string is string and required"), XMLString]), v.check(isOptionalXMLNumber, "XMLNumber: string is not a number"), v.transform(parseOptionalXMLNumber)));
-const XMLBoolean = v.pipe(v.union([v.string("XMLBoolean: string is string and required"), XMLString]), v.check((val) => {
-	const payload = getXMLStringPayload(val);
+const XMLBoolean = v.pipe(v.union([v.string("XMLBoolean: string is string and required"), XMLString]), v.check((value) => {
+	const payload = getXMLStringPayload(value);
 	return payload === "true" || payload === "false";
-}, "XMLBoolean: string is not a boolean"), v.transform((val) => getXMLStringPayload(val) === "true"));
+}, "XMLBoolean: string is not a boolean"), v.transform((value) => getXMLStringPayload(value) === "true"));
 function customDateTime(message) {
 	return v.pipe(v.union([v.string(message), XMLString]), v.check(isXMLDate, message ?? "Invalid datetime format. Expected ISO date/time or YYYY-MM-DD HH:mm:ss"), v.transform(parseXMLDate));
 }
@@ -416,6 +416,11 @@ const XMLTree = v.object({
 	...XMLBaseItem.entries,
 	date: v.optional(v.union([customDateTime("XMLTree: date is not a valid datetime"), XMLString])),
 	links: v.optional(v.lazy(() => XMLLink)),
+	reverseLinks: v.optional(v.union([
+		v.lazy(() => XMLLink),
+		v.lazy(() => XMLDataItem),
+		v.array(v.union([v.lazy(() => XMLLink), v.lazy(() => XMLDataItem)]))
+	])),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	bibliographies: v.optional(v.object({ bibliography: v.array(v.lazy(() => XMLBibliography)) })),
@@ -440,6 +445,11 @@ const XMLSet = v.object({
 	suppressBlanks: v.optional(XMLBoolean),
 	tabularStructure: v.optional(XMLBoolean),
 	links: v.optional(v.lazy(() => XMLLink)),
+	reverseLinks: v.optional(v.union([
+		v.lazy(() => XMLLink),
+		v.lazy(() => XMLDataItem),
+		v.array(v.union([v.lazy(() => XMLLink), v.lazy(() => XMLDataItem)]))
+	])),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	items: v.optional(v.object({
@@ -491,6 +501,11 @@ const XMLBibliography = v.object({
 	authors: v.optional(v.object({ person: v.array(v.lazy(() => XMLPerson)) })),
 	periods: v.optional(v.object({ period: v.array(v.lazy(() => XMLPeriod)) })),
 	links: v.optional(v.lazy(() => XMLLink)),
+	reverseLinks: v.optional(v.union([
+		v.lazy(() => XMLLink),
+		v.lazy(() => XMLDataItem),
+		v.array(v.union([v.lazy(() => XMLLink), v.lazy(() => XMLDataItem)]))
+	])),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	bibliographies: v.optional(v.object({ bibliography: v.array(v.lazy(() => XMLBibliography)) })),
@@ -499,9 +514,14 @@ const XMLBibliography = v.object({
 const XMLInterpretation = v.object({
 	interpretationNo: XMLNumber,
 	date: v.optional(customDateTime("XMLInterpretation: date is not a valid datetime")),
-	observers: v.optional(v.object({ observer: v.array(v.lazy(() => XMLPerson)) })),
+	interpreters: v.optional(v.object({ interpreter: v.array(v.lazy(() => XMLPerson)) })),
 	periods: v.optional(v.object({ period: v.array(v.lazy(() => XMLPeriod)) })),
 	links: v.optional(v.lazy(() => XMLLink)),
+	reverseLinks: v.optional(v.union([
+		v.lazy(() => XMLLink),
+		v.lazy(() => XMLDataItem),
+		v.array(v.union([v.lazy(() => XMLLink), v.lazy(() => XMLDataItem)]))
+	])),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	bibliographies: v.optional(v.object({ bibliography: v.array(XMLBibliography) }))
@@ -510,6 +530,7 @@ const XMLConcept = v.object({
 	...XMLBaseItem.entries,
 	image: v.optional(XMLImage),
 	interpretations: v.optional(v.object({ interpretation: v.array(XMLInterpretation) })),
+	interpretation: v.optional(v.array(XMLInterpretation)),
 	coordinates: v.optional(XMLCoordinates),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	concept: v.optional(v.array(v.lazy(() => XMLConcept)))
@@ -520,6 +541,11 @@ const XMLObservation = v.object({
 	observers: v.optional(v.object({ observer: v.array(v.lazy(() => XMLPerson)) })),
 	periods: v.optional(v.object({ period: v.array(v.lazy(() => XMLPeriod)) })),
 	links: v.optional(v.lazy(() => XMLLink)),
+	reverseLinks: v.optional(v.union([
+		v.lazy(() => XMLLink),
+		v.lazy(() => XMLDataItem),
+		v.array(v.union([v.lazy(() => XMLLink), v.lazy(() => XMLDataItem)]))
+	])),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	bibliographies: v.optional(v.object({ bibliography: v.array(XMLBibliography) }))
@@ -533,6 +559,7 @@ const XMLSpatialUnit = v.object({
 		EPSG: XMLNumber
 	}) }, "XMLSpatialUnit: mapData is object with geoJSON")),
 	observations: v.optional(v.object({ observation: v.array(XMLObservation) })),
+	observation: v.optional(v.array(XMLObservation)),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	bibliographies: v.optional(v.object({ bibliography: v.array(XMLBibliography) })),
 	spatialUnit: v.optional(v.array(v.lazy(() => XMLSpatialUnit)))
@@ -542,6 +569,11 @@ const XMLPeriod = v.object({
 	type: v.optional(v.string("XMLPeriod: type is string and optional")),
 	coordinates: v.optional(XMLCoordinates),
 	links: v.optional(v.lazy(() => XMLDataItem)),
+	reverseLinks: v.optional(v.union([
+		v.lazy(() => XMLLink),
+		v.lazy(() => XMLDataItem),
+		v.array(v.union([v.lazy(() => XMLLink), v.lazy(() => XMLDataItem)]))
+	])),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	bibliographies: v.optional(v.object({ bibliography: v.array(XMLBibliography) })),
@@ -561,6 +593,11 @@ const XMLPerson = v.object({
 	coordinates: v.optional(XMLCoordinates),
 	periods: v.optional(v.object({ period: v.array(XMLPeriod) })),
 	links: v.optional(v.lazy(() => XMLLink)),
+	reverseLinks: v.optional(v.union([
+		v.lazy(() => XMLLink),
+		v.lazy(() => XMLDataItem),
+		v.array(v.union([v.lazy(() => XMLLink), v.lazy(() => XMLDataItem)]))
+	])),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	bibliographies: v.optional(v.object({ bibliography: v.array(XMLBibliography) }))
@@ -569,6 +606,11 @@ const XMLPropertyValue = v.object({
 	...XMLBaseItem.entries,
 	coordinates: v.optional(XMLCoordinates),
 	links: v.optional(v.lazy(() => XMLLink)),
+	reverseLinks: v.optional(v.union([
+		v.lazy(() => XMLLink),
+		v.lazy(() => XMLDataItem),
+		v.array(v.union([v.lazy(() => XMLLink), v.lazy(() => XMLDataItem)]))
+	])),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	properties: v.optional(v.object({ property: v.array(XMLProperty) })),
 	bibliographies: v.optional(v.object({ bibliography: v.array(XMLBibliography) }))
@@ -578,6 +620,11 @@ const XMLPropertyVariable = v.object({
 	type: v.optional(v.string("XMLPropertyVariable: type is string and optional")),
 	coordinates: v.optional(XMLCoordinates),
 	links: v.optional(v.lazy(() => XMLLink)),
+	reverseLinks: v.optional(v.union([
+		v.lazy(() => XMLLink),
+		v.lazy(() => XMLDataItem),
+		v.array(v.union([v.lazy(() => XMLLink), v.lazy(() => XMLDataItem)]))
+	])),
 	notes: v.optional(v.object({ note: v.array(XMLNote) })),
 	bibliographies: v.optional(v.object({ bibliography: v.array(XMLBibliography) }))
 }, "XMLPropertyVariable: Shape error");
@@ -657,9 +704,9 @@ const XMLLink = v.pipe(v.object({
 	text: v.optional(v.array(XMLLinkedText)),
 	set: v.optional(v.array(XMLLinkedSet)),
 	dictionaryUnit: v.optional(v.array(XMLDictionaryUnit))
-}, "XMLLink: Shape error"), v.check((val) => {
-	if (Object.keys(val).length > 0) return true;
-	for (const knownCategory of ITEM_CATEGORIES) if (val[knownCategory] != null) return true;
+}, "XMLLink: Shape error"), v.check((value) => {
+	if (Object.keys(value).length > 0) return true;
+	for (const knownCategory of ITEM_CATEGORIES) if (value[knownCategory] != null) return true;
 	return false;
 }, "XMLLink: at least one link category is required"));
 const XMLWebsiteContextLevel = v.intersect([XMLString, v.object({
@@ -790,20 +837,25 @@ const XMLDataItem = v.union([
 ], "XMLDataItem: Shape error");
 const XMLTopLevelDataItem = v.pipe(XMLDataItem, v.check((dataItem) => {
 	if ("tree" in dataItem) return true;
-	if ("bibliography" in dataItem) {
-		for (const bibliography of dataItem.bibliography) for (const child of bibliography.bibliography ?? []) if ((child.bibliography?.length ?? 0) > 0) return false;
+	if ("bibliography" in dataItem) for (const bibliography of dataItem.bibliography) {
+		const children = bibliography.bibliography ?? [];
+		for (const child of children) if ((child.bibliography?.length ?? 0) > 0) return false;
 	}
-	if ("concept" in dataItem) {
-		for (const concept of dataItem.concept) for (const child of concept.concept ?? []) if ((child.concept?.length ?? 0) > 0) return false;
+	if ("concept" in dataItem) for (const concept of dataItem.concept) {
+		const children = concept.concept ?? [];
+		for (const child of children) if ((child.concept?.length ?? 0) > 0) return false;
 	}
-	if ("spatialUnit" in dataItem) {
-		for (const spatialUnit of dataItem.spatialUnit) for (const child of spatialUnit.spatialUnit ?? []) if ((child.spatialUnit?.length ?? 0) > 0) return false;
+	if ("spatialUnit" in dataItem) for (const spatialUnit of dataItem.spatialUnit) {
+		const children = spatialUnit.spatialUnit ?? [];
+		for (const child of children) if ((child.spatialUnit?.length ?? 0) > 0) return false;
 	}
-	if ("period" in dataItem) {
-		for (const period of dataItem.period) for (const child of period.period ?? []) if ((child.period?.length ?? 0) > 0) return false;
+	if ("period" in dataItem) for (const period of dataItem.period) {
+		const children = period.period ?? [];
+		for (const child of children) if ((child.period?.length ?? 0) > 0) return false;
 	}
-	if ("resource" in dataItem) {
-		for (const resource of dataItem.resource) for (const child of resource.resource ?? []) if ((child.resource?.length ?? 0) > 0) return false;
+	if ("resource" in dataItem) for (const resource of dataItem.resource) {
+		const children = resource.resource ?? [];
+		for (const child of children) if ((child.resource?.length ?? 0) > 0) return false;
 	}
 	return true;
 }, "XMLDataItem: standalone recursive item children cannot contain nested recursive children"));

package/dist/xml/types.d.mts

@@ -299,6 +299,7 @@ type XMLBibliography = Partial<XMLBaseItem> & {
     period: Array<XMLPeriod>;
   };
   links?: XMLLink;
+  reverseLinks?: XMLLink | XMLDataItem | Array<XMLLink | XMLDataItem>;
   notes?: {
     note: Array<XMLNote>;
   };
@@ -401,13 +402,14 @@ type XMLDictionaryUnit = XMLLinkedBaseItem;
 type XMLInterpretation = {
   interpretationNo: XMLNumber;
   date?: Date;
-  observers?: {
-    observer: Array<XMLPerson>;
+  interpreters?: {
+    interpreter: Array<XMLPerson>;
   };
   periods?: {
     period: Array<XMLPeriod>;
   };
   links?: XMLLink;
+  reverseLinks?: XMLLink | XMLDataItem | Array<XMLLink | XMLDataItem>;
   notes?: {
     note: Array<XMLNote>;
   };
@@ -424,6 +426,7 @@ type XMLConcept = XMLBaseItem & {
   interpretations?: {
     interpretation: Array<XMLInterpretation>;
   };
+  interpretation?: Array<XMLInterpretation>;
   coordinates?: XMLCoordinates;
   properties?: {
     property: Array<XMLProperty>;
@@ -440,6 +443,7 @@ type XMLObservation = {
     period: Array<XMLPeriod>;
   };
   links?: XMLLink;
+  reverseLinks?: XMLLink | XMLDataItem | Array<XMLLink | XMLDataItem>;
   notes?: {
     note: Array<XMLNote>;
   };
@@ -464,6 +468,7 @@ type XMLSpatialUnit = XMLBaseItem & {
   observations?: {
     observation: Array<XMLObservation>;
   };
+  observation?: Array<XMLObservation>;
   properties?: {
     property: Array<XMLProperty>;
   };
@@ -476,6 +481,7 @@ type XMLPeriod = XMLBaseItem & {
   type?: string;
   coordinates?: XMLCoordinates;
   links?: XMLDataItem;
+  reverseLinks?: XMLLink | XMLDataItem | Array<XMLLink | XMLDataItem>;
   notes?: {
     note: Array<XMLNote>;
   };
@@ -501,6 +507,7 @@ type XMLPerson = XMLBaseItem & Partial<XMLContent> & {
     period: Array<XMLPeriod>;
   };
   links?: XMLLink;
+  reverseLinks?: XMLLink | XMLDataItem | Array<XMLLink | XMLDataItem>;
   notes?: {
     note: Array<XMLNote>;
   };
@@ -515,6 +522,7 @@ type XMLPropertyVariable = XMLBaseItem & {
   type?: string;
   coordinates?: XMLCoordinates;
   links?: XMLLink;
+  reverseLinks?: XMLLink | XMLDataItem | Array<XMLLink | XMLDataItem>;
   notes?: {
     note: Array<XMLNote>;
   };
@@ -525,6 +533,7 @@ type XMLPropertyVariable = XMLBaseItem & {
 type XMLPropertyValue = XMLBaseItem & {
   coordinates?: XMLCoordinates;
   links?: XMLLink;
+  reverseLinks?: XMLLink | XMLDataItem | Array<XMLLink | XMLDataItem>;
   notes?: {
     note: Array<XMLNote>;
   };
@@ -588,14 +597,14 @@ type XMLText = XMLBaseItem & {
   notes?: {
     note: Array<XMLNote>;
   };
-  sections?: {
+  sections?: XMLString | {
     translation?: Array<{
       section: Array<XMLSection>;
     }>;
     phonemic?: Array<{
       section: Array<XMLSection>;
     }>;
-  } | XMLString;
+  };
   periods?: {
     period: Array<XMLPeriod>;
   };
@@ -633,6 +642,7 @@ type XMLTree = XMLBaseItem & {
   type?: string;
   date?: Date | XMLString;
   links?: XMLLink;
+  reverseLinks?: XMLLink | XMLDataItem | Array<XMLLink | XMLDataItem>;
   notes?: {
     note: Array<XMLNote>;
   };
@@ -747,6 +757,7 @@ type XMLSet = XMLBaseItem & {
   suppressBlanks?: XMLBoolean;
   tabularStructure?: XMLBoolean;
   links?: XMLLink;
+  reverseLinks?: XMLLink | XMLDataItem | Array<XMLLink | XMLDataItem>;
   notes?: {
     note: Array<XMLNote>;
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "1.0.53",
+  "version": "1.0.55",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -47,16 +47,16 @@
   "dependencies": {
     "date-fns": "^4.4.0",
     "fast-equals": "^6.0.0",
-    "fast-xml-parser": "^5.9.2",
+    "fast-xml-parser": "^5.9.3",
     "valibot": "^1.4.1"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^9.0.0",
+    "@antfu/eslint-config": "^9.1.0",
     "@types/node": "^24.13.2",
     "bumpp": "^11.1.0",
     "eslint": "^10.5.0",
-    "knip": "^6.17.1",
-    "oxfmt": "^0.55.0",
+    "knip": "^6.20.0",
+    "oxfmt": "^0.56.0",
     "tsdown": "^0.22.3",
     "typescript": "^6.0.3",
     "vitest": "^4.1.9"