@digitalculture/ochre-sdk 0.15.8 → 0.15.10

package/dist/index.d.mts

@@ -9,6 +9,7 @@ type Data<T extends DataCategory = DataCategory, U extends DataCategory = (T ext
     abbreviation: string;
   };
   publicationDateTime: Date;
+  persistentUrl: string | null;
   item: Item<T, U>;
 };
 /**
@@ -87,6 +88,7 @@ type Person = {
   category: "person";
   metadata: Metadata | null;
   publicationDateTime: Date | null;
+  persistentUrl: string | null;
   type: string | null;
   number: number | null;
   context: Context | null;
@@ -290,6 +292,7 @@ type Resource = {
   category: "resource";
   metadata: Metadata | null;
   publicationDateTime: Date | null;
+  persistentUrl: string | null;
   type: string;
   number: number;
   context: Context | null;
@@ -323,6 +326,7 @@ type SpatialUnit = {
   category: "spatialUnit";
   metadata: Metadata | null;
   publicationDateTime: Date | null;
+  persistentUrl: string | null;
   number: number;
   context: Context | null;
   license: License | null;
@@ -349,6 +353,7 @@ type Concept = {
   category: "concept";
   metadata: Metadata | null;
   publicationDateTime: Date | null;
+  persistentUrl: string | null;
   number: number;
   license: License | null;
   context: Context | null;
@@ -369,6 +374,7 @@ type Set<U extends DataCategory = DataCategory> = {
   metadata: Metadata | null;
   itemCategories: Array<U>;
   publicationDateTime: Date | null;
+  persistentUrl: string | null;
   type: string;
   number: number;
   date: string | null;
@@ -388,6 +394,7 @@ type Bibliography = {
   category: "bibliography";
   metadata: Metadata | null;
   publicationDateTime: Date | null;
+  persistentUrl: string | null;
   type: string | null;
   number: number | null;
   identification: Identification | null;
@@ -423,6 +430,7 @@ type Period = {
   category: "period";
   metadata: Metadata | null;
   publicationDateTime: Date | null;
+  persistentUrl: string | null;
   type: string | null;
   number: number | null;
   identification: Identification;
@@ -436,6 +444,7 @@ type PropertyValue = {
   uuid: string;
   category: "propertyValue";
   metadata: Metadata | null;
+  persistentUrl: string | null;
   number: number;
   publicationDateTime: Date | null;
   context: Context | null;
@@ -453,6 +462,7 @@ type PropertyValueContentType = "string" | "integer" | "decimal" | "boolean" | "
  * Represents a property value with type information
  */
 type PropertyValueContent<T extends PropertyValueContentType> = {
+  hierarchyLevel: number | null;
   content: (T extends "integer" ? number : T extends "decimal" ? number : T extends "time" ? number : T extends "boolean" ? boolean : string) | null;
   dataType: T;
   label: string | null;
@@ -486,6 +496,7 @@ type Text = {
   category: "text";
   metadata: Metadata | null;
   publicationDateTime: Date | null;
+  persistentUrl: string | null;
   type: string | null;
   language: string | null;
   number: number;
@@ -525,6 +536,7 @@ type Tree<U extends Exclude<DataCategory, "tree"> = Exclude<DataCategory, "tree"
   category: "tree";
   metadata: Metadata | null;
   publicationDateTime: Date | null;
+  persistentUrl: string | null;
   type: string;
   number: number;
   date: string | null;
@@ -551,7 +563,7 @@ type PropertyQueryItem = {
     uuid: string | null;
     category: string | null;
     type: string | null;
-    dataType: string;
+    dataType: string | null;
     publicationDateTime: string | null;
     content: string;
     label: string | null;

package/dist/index.mjs

@@ -935,12 +935,13 @@ function parseLicense(license) {
 * @param person - Raw person data from OCHRE format
 * @returns Parsed Person object
 */
-function parsePerson(person, metadata) {
+function parsePerson(person, metadata, persistentUrl) {
 	return {
 		uuid: person.uuid,
 		category: "person",
 		metadata: metadata ?? null,
 		publicationDateTime: person.publicationDateTime != null ? new Date(person.publicationDateTime) : null,
+		persistentUrl: persistentUrl ?? null,
 		type: person.type ?? null,
 		number: person.n ?? null,
 		context: person.context ? parseContext(person.context) : null,
@@ -1224,6 +1225,7 @@ function parseProperty(property, language = "eng") {
 		if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
 			content = parseFakeString(value);
 			return {
+				hierarchyLevel: null,
 				content,
 				label: null,
 				dataType: "string",
@@ -1279,6 +1281,7 @@ function parseProperty(property, language = "eng") {
 					break;
 			}
 			return {
+				hierarchyLevel: value.i ?? null,
 				content,
 				dataType: parsedType,
 				isUncertain: value.isUncertain ?? false,
@@ -1295,6 +1298,9 @@ function parseProperty(property, language = "eng") {
 				slug: value.slug ?? null
 			};
 		}
+	}).toSorted((a, b) => {
+		if (a.hierarchyLevel != null && b.hierarchyLevel != null) return b.hierarchyLevel - a.hierarchyLevel;
+		return 0;
 	});
 	return {
 		uuid: property.label.uuid,
@@ -1363,12 +1369,13 @@ function parseImageMap(imageMap) {
 * @param period - Raw period data in OCHRE format
 * @returns Parsed Period object
 */
-function parsePeriod(period, metadata) {
+function parsePeriod(period, metadata, persistentUrl) {
 	return {
 		uuid: period.uuid,
 		category: "period",
 		metadata: metadata ?? null,
 		publicationDateTime: period.publicationDateTime != null ? new Date(period.publicationDateTime) : null,
+		persistentUrl: persistentUrl ?? null,
 		type: period.type ?? null,
 		number: period.n ?? null,
 		identification: parseIdentification(period.identification),
@@ -1393,7 +1400,7 @@ function parsePeriods(periods) {
 * @param bibliography - Raw bibliography data in OCHRE format
 * @returns Parsed Bibliography object
 */
-function parseBibliography(bibliography, metadata) {
+function parseBibliography(bibliography, metadata, persistentUrl) {
 	const sourceResources = [];
 	if (bibliography.source?.resource) {
 		const resourcesToParse = Array.isArray(bibliography.source.resource) ? bibliography.source.resource : [bibliography.source.resource];
@@ -1424,6 +1431,7 @@ function parseBibliography(bibliography, metadata) {
 		category: "bibliography",
 		metadata: metadata ?? null,
 		publicationDateTime: bibliography.publicationDateTime != null ? new Date(bibliography.publicationDateTime) : null,
+		persistentUrl: persistentUrl ?? null,
 		type: bibliography.type ?? null,
 		number: bibliography.n ?? null,
 		identification: bibliography.identification ? parseIdentification(bibliography.identification) : null,
@@ -1469,13 +1477,14 @@ function parseBibliographies(bibliographies) {
 * @param propertyValue - Raw property value data in OCHRE format
 * @returns Parsed PropertyValue object
 */
-function parsePropertyValue(propertyValue, metadata) {
+function parsePropertyValue(propertyValue, metadata, persistentUrl) {
 	return {
 		uuid: propertyValue.uuid,
 		category: "propertyValue",
 		metadata: metadata ?? null,
 		number: propertyValue.n,
 		publicationDateTime: propertyValue.publicationDateTime ? new Date(propertyValue.publicationDateTime) : null,
+		persistentUrl: persistentUrl ?? null,
 		context: propertyValue.context ? parseContext(propertyValue.context) : null,
 		availability: propertyValue.availability ? parseLicense(propertyValue.availability) : null,
 		identification: parseIdentification(propertyValue.identification),
@@ -1504,12 +1513,13 @@ function parsePropertyValues(propertyValues) {
 * @param text - Raw text data in OCHRE format
 * @returns Parsed Text object
 */
-function parseText(text, metadata) {
+function parseText(text, metadata, persistentUrl) {
 	return {
 		uuid: text.uuid,
 		category: "text",
 		metadata: metadata ?? null,
 		publicationDateTime: text.publicationDateTime ? new Date(text.publicationDateTime) : null,
+		persistentUrl: persistentUrl ?? null,
 		type: text.type ?? null,
 		language: text.language ?? null,
 		number: text.n ?? 0,
@@ -1582,7 +1592,7 @@ function parseSections(sections) {
 * @param tree - Raw tree data in OCHRE format
 * @returns Parsed Tree object or null if invalid
 */
-function parseTree(tree, itemCategory, metadata) {
+function parseTree(tree, itemCategory, metadata, persistentUrl) {
 	if (typeof tree.items === "string") throw new TypeError("Invalid OCHRE data: Tree has no items");
 	let creators = [];
 	if (tree.creators) creators = parsePersons(Array.isArray(tree.creators.creator) ? tree.creators.creator : [tree.creators.creator]);
@@ -1637,6 +1647,7 @@ function parseTree(tree, itemCategory, metadata) {
 		category: "tree",
 		metadata: metadata ?? null,
 		publicationDateTime: new Date(tree.publicationDateTime),
+		persistentUrl: persistentUrl ?? null,
 		identification: parseIdentification(tree.identification),
 		creators,
 		license: parseLicense(tree.availability),
@@ -1653,7 +1664,7 @@ function parseTree(tree, itemCategory, metadata) {
 * @param set - Raw set data in OCHRE format
 * @returns Parsed Set object
 */
-function parseSet(set, itemCategories, metadata) {
+function parseSet(set, itemCategories, metadata, persistentUrl) {
 	if (typeof set.items === "string") throw new TypeError("Invalid OCHRE data: Set has no items");
 	const parsedItemCategories = itemCategories ?? getItemCategories(Object.keys(set.items));
 	let items = [];
@@ -1698,6 +1709,7 @@ function parseSet(set, itemCategories, metadata) {
 		metadata: metadata ?? null,
 		itemCategories: parsedItemCategories,
 		publicationDateTime: set.publicationDateTime ? new Date(set.publicationDateTime) : null,
+		persistentUrl: persistentUrl ?? null,
 		date: set.date ?? null,
 		license: parseLicense(set.availability),
 		identification: parseIdentification(set.identification),
@@ -1719,12 +1731,13 @@ function parseSet(set, itemCategories, metadata) {
 * @param resource - Raw resource data in OCHRE format
 * @returns Parsed Resource object
 */
-function parseResource(resource, metadata) {
+function parseResource(resource, metadata, persistentUrl) {
 	return {
 		uuid: resource.uuid,
 		category: "resource",
 		metadata: metadata ?? null,
 		publicationDateTime: resource.publicationDateTime ? new Date(resource.publicationDateTime) : null,
+		persistentUrl: persistentUrl ?? null,
 		type: resource.type,
 		number: resource.n,
 		fileFormat: resource.fileFormat ?? null,
@@ -1773,12 +1786,13 @@ function parseResources(resources) {
 * @param spatialUnit - Raw spatial unit in OCHRE format
 * @returns Parsed SpatialUnit object
 */
-function parseSpatialUnit(spatialUnit, metadata) {
+function parseSpatialUnit(spatialUnit, metadata, persistentUrl) {
 	return {
 		uuid: spatialUnit.uuid,
 		category: "spatialUnit",
 		metadata: metadata ?? null,
 		publicationDateTime: spatialUnit.publicationDateTime != null ? new Date(spatialUnit.publicationDateTime) : null,
+		persistentUrl: persistentUrl ?? null,
 		number: spatialUnit.n,
 		context: "context" in spatialUnit && spatialUnit.context ? parseContext(spatialUnit.context) : null,
 		license: "availability" in spatialUnit && spatialUnit.availability ? parseLicense(spatialUnit.availability) : null,
@@ -1815,12 +1829,13 @@ function parseSpatialUnits(spatialUnits) {
 * @param concept - Raw concept data in OCHRE format
 * @returns Parsed Concept object
 */
-function parseConcept(concept, metadata) {
+function parseConcept(concept, metadata, persistentUrl) {
 	return {
 		uuid: concept.uuid,
 		category: "concept",
 		metadata: metadata ?? null,
 		publicationDateTime: concept.publicationDateTime ? new Date(concept.publicationDateTime) : null,
+		persistentUrl: persistentUrl ?? null,
 		number: concept.n,
 		license: "availability" in concept && concept.availability ? parseLicense(concept.availability) : null,
 		context: "context" in concept && concept.context ? parseContext(concept.context) : null,
@@ -3158,43 +3173,43 @@ async function fetchItem(uuid, category, itemCategory, options) {
 		switch (categoryKey) {
 			case "resource":
 				if (!("resource" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'resource' key");
-				item = parseResource(data.ochre.resource, metadata);
+				item = parseResource(data.ochre.resource, metadata, data.ochre.persistentUrl);
 				break;
 			case "spatialUnit":
 				if (!("spatialUnit" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'spatialUnit' key");
-				item = parseSpatialUnit(data.ochre.spatialUnit, metadata);
+				item = parseSpatialUnit(data.ochre.spatialUnit, metadata, data.ochre.persistentUrl);
 				break;
 			case "concept":
 				if (!("concept" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'concept' key");
-				item = parseConcept(data.ochre.concept, metadata);
+				item = parseConcept(data.ochre.concept, metadata, data.ochre.persistentUrl);
 				break;
 			case "period":
 				if (!("period" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'period' key");
-				item = parsePeriod(data.ochre.period, metadata);
+				item = parsePeriod(data.ochre.period, metadata, data.ochre.persistentUrl);
 				break;
 			case "bibliography":
 				if (!("bibliography" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'bibliography' key");
-				item = parseBibliography(data.ochre.bibliography, metadata);
+				item = parseBibliography(data.ochre.bibliography, metadata, data.ochre.persistentUrl);
 				break;
 			case "person":
 				if (!("person" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'person' key");
-				item = parsePerson(data.ochre.person, metadata);
+				item = parsePerson(data.ochre.person, metadata, data.ochre.persistentUrl);
 				break;
 			case "propertyValue":
 				if (!("propertyValue" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'propertyValue' key");
-				item = parsePropertyValue(data.ochre.propertyValue, metadata);
+				item = parsePropertyValue(data.ochre.propertyValue, metadata, data.ochre.persistentUrl);
 				break;
 			case "text":
 				if (!("text" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'text' key");
-				item = parseText(data.ochre.text, metadata);
+				item = parseText(data.ochre.text, metadata, data.ochre.persistentUrl);
 				break;
 			case "set":
 				if (!("set" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'set' key");
-				item = parseSet(data.ochre.set, itemCategory, metadata);
+				item = parseSet(data.ochre.set, itemCategory, metadata, data.ochre.persistentUrl);
 				break;
 			case "tree":
 				if (!("tree" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'tree' key");
-				item = parseTree(data.ochre.tree, itemCategory, metadata);
+				item = parseTree(data.ochre.tree, itemCategory, metadata, data.ochre.persistentUrl);
 				break;
 			default: throw new Error("Invalid category");
 		}
@@ -3244,7 +3259,7 @@ const responseItemSchema = z.object({
 		uuid: z.string().refine(isUUID).optional(),
 		category: z.string().optional(),
 		type: z.string().optional(),
-		dataType: z.string(),
+		dataType: z.string().optional(),
 		publicationDateTime: z.string().optional(),
 		content: z.string().optional(),
 		rawValue: z.string().optional()
@@ -3316,7 +3331,7 @@ async function fetchPropertyQuery(scopeUuids, propertyUuids, options) {
 					uuid: valueUuid ?? null,
 					category: item.value.category ?? null,
 					type: item.value.type ?? null,
-					dataType: item.value.dataType,
+					dataType: item.value.dataType ?? null,
 					publicationDateTime: item.value.publicationDateTime ?? null,
 					content: item.value.rawValue ?? item.value.content ?? "",
 					label: item.value.rawValue != null && item.value.content != null ? item.value.content : null

package/package.json

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