@digitalculture/ochre-sdk 0.16.1 → 0.16.2

package/dist/index.d.mts

@@ -88,7 +88,7 @@ type Person = {
   category: "person";
   belongsTo: {
     uuid: string;
-    name: string;
+    abbreviation: string;
   } | null;
   metadata: Metadata | null;
   publicationDateTime: Date | null;
@@ -296,7 +296,7 @@ type Resource = {
   category: "resource";
   belongsTo: {
     uuid: string;
-    name: string;
+    abbreviation: string;
   } | null;
   metadata: Metadata | null;
   publicationDateTime: Date | null;
@@ -334,7 +334,7 @@ type SpatialUnit = {
   category: "spatialUnit";
   belongsTo: {
     uuid: string;
-    name: string;
+    abbreviation: string;
   } | null;
   metadata: Metadata | null;
   publicationDateTime: Date | null;
@@ -365,7 +365,7 @@ type Concept = {
   category: "concept";
   belongsTo: {
     uuid: string;
-    name: string;
+    abbreviation: string;
   } | null;
   metadata: Metadata | null;
   publicationDateTime: Date | null;
@@ -389,7 +389,7 @@ type Set<U extends DataCategory = DataCategory> = {
   category: "set";
   belongsTo: {
     uuid: string;
-    name: string;
+    abbreviation: string;
   } | null;
   metadata: Metadata | null;
   itemCategories: Array<U>;
@@ -414,7 +414,7 @@ type Bibliography = {
   category: "bibliography";
   belongsTo: {
     uuid: string;
-    name: string;
+    abbreviation: string;
   } | null;
   metadata: Metadata | null;
   publicationDateTime: Date | null;
@@ -454,7 +454,7 @@ type Period = {
   category: "period";
   belongsTo: {
     uuid: string;
-    name: string;
+    abbreviation: string;
   } | null;
   metadata: Metadata | null;
   publicationDateTime: Date | null;
@@ -473,7 +473,7 @@ type PropertyValue = {
   category: "propertyValue";
   belongsTo: {
     uuid: string;
-    name: string;
+    abbreviation: string;
   } | null;
   metadata: Metadata | null;
   persistentUrl: string | null;
@@ -528,7 +528,7 @@ type Text = {
   category: "text";
   belongsTo: {
     uuid: string;
-    name: string;
+    abbreviation: string;
   } | null;
   metadata: Metadata | null;
   publicationDateTime: Date | null;
@@ -572,7 +572,7 @@ type Tree<U extends Exclude<DataCategory, "tree"> = Exclude<DataCategory, "tree"
   category: "tree";
   belongsTo: {
     uuid: string;
-    name: string;
+    abbreviation: string;
   } | null;
   metadata: Metadata | null;
   publicationDateTime: Date | null;
@@ -666,12 +666,13 @@ type Scope = {
 type Website = {
   uuid: string;
   version: 1 | 2;
+  belongsTo: {
+    uuid: string;
+    abbreviation: string;
+  } | null;
+  metadata: Metadata;
   publicationDateTime: Date | null;
   identification: Identification;
-  project: {
-    name: string;
-    website: string | null;
-  };
   creators: Array<Person>;
   license: License | null;
   pages: Array<Webpage>;

package/dist/index.mjs

@@ -3153,7 +3153,7 @@ function parseContexts(contexts) {
 	}
 	return contextsParsed;
 }
-function parseWebsite(websiteTree, projectName, website, { isVersion2 = false } = {}) {
+function parseWebsite(websiteTree, metadata, belongsTo, { isVersion2 = false } = {}) {
 	if (!websiteTree.properties) throw new Error("Website properties not found");
 	const properties = parseWebsiteProperties(Array.isArray(websiteTree.properties.property) ? websiteTree.properties.property : [websiteTree.properties.property], websiteTree);
 	if (typeof websiteTree.items === "string" || !("resource" in websiteTree.items)) throw new Error("Website pages not found");
@@ -3163,12 +3163,10 @@ function parseWebsite(websiteTree, projectName, website, { isVersion2 = false }
 	return {
 		uuid: websiteTree.uuid,
 		version: isVersion2 ? 2 : 1,
+		belongsTo: belongsTo ?? null,
+		metadata: parseMetadata(metadata),
 		publicationDateTime: websiteTree.publicationDateTime ? new Date(websiteTree.publicationDateTime) : null,
 		identification: parseIdentification(websiteTree.identification),
-		project: {
-			name: parseFakeString(projectName),
-			website: website !== null ? parseFakeString(website) : null
-		},
 		creators: websiteTree.creators ? parsePersons(Array.isArray(websiteTree.creators.creator) ? websiteTree.creators.creator : [websiteTree.creators.creator]) : [],
 		license: parseLicense(websiteTree.availability),
 		sidebar,
@@ -3323,78 +3321,55 @@ async function fetchItem(uuid, category, itemCategory, options) {
 		});
 		if (error !== null) throw new Error(error);
 		const categoryKey = getItemCategory(Object.keys(data.ochre));
+		const belongsTo = {
+			uuid: data.ochre.uuidBelongsTo,
+			abbreviation: parseFakeString(data.ochre.belongsTo)
+		};
 		const metadata = parseMetadata(data.ochre.metadata);
 		let item;
 		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, data.ochre.persistentUrl, {
-					uuid: data.ochre.uuidBelongsTo,
-					name: parseFakeString(data.ochre.belongsTo)
-				});
+				item = parseResource(data.ochre.resource, metadata, data.ochre.persistentUrl, belongsTo);
 				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, data.ochre.persistentUrl, {
-					uuid: data.ochre.uuidBelongsTo,
-					name: parseFakeString(data.ochre.belongsTo)
-				});
+				item = parseSpatialUnit(data.ochre.spatialUnit, metadata, data.ochre.persistentUrl, belongsTo);
 				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, data.ochre.persistentUrl, {
-					uuid: data.ochre.uuidBelongsTo,
-					name: parseFakeString(data.ochre.belongsTo)
-				});
+				item = parseConcept(data.ochre.concept, metadata, data.ochre.persistentUrl, belongsTo);
 				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, data.ochre.persistentUrl, {
 					uuid: data.ochre.uuidBelongsTo,
-					name: parseFakeString(data.ochre.belongsTo)
+					abbreviation: parseFakeString(data.ochre.belongsTo)
 				});
 				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, data.ochre.persistentUrl, {
-					uuid: data.ochre.uuidBelongsTo,
-					name: parseFakeString(data.ochre.belongsTo)
-				});
+				item = parseBibliography(data.ochre.bibliography, metadata, data.ochre.persistentUrl, belongsTo);
 				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, data.ochre.persistentUrl, {
-					uuid: data.ochre.uuidBelongsTo,
-					name: parseFakeString(data.ochre.belongsTo)
-				});
+				item = parsePerson(data.ochre.person, metadata, data.ochre.persistentUrl, belongsTo);
 				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, data.ochre.persistentUrl, {
-					uuid: data.ochre.uuidBelongsTo,
-					name: parseFakeString(data.ochre.belongsTo)
-				});
+				item = parsePropertyValue(data.ochre.propertyValue, metadata, data.ochre.persistentUrl, belongsTo);
 				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, data.ochre.persistentUrl, {
-					uuid: data.ochre.uuidBelongsTo,
-					name: parseFakeString(data.ochre.belongsTo)
-				});
+				item = parseText(data.ochre.text, metadata, data.ochre.persistentUrl, belongsTo);
 				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, data.ochre.persistentUrl, {
-					uuid: data.ochre.uuidBelongsTo,
-					name: parseFakeString(data.ochre.belongsTo)
-				});
+				item = parseSet(data.ochre.set, itemCategory, metadata, data.ochre.persistentUrl, belongsTo);
 				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, data.ochre.persistentUrl, {
-					uuid: data.ochre.uuidBelongsTo,
-					name: parseFakeString(data.ochre.belongsTo)
-				});
+				item = parseTree(data.ochre.tree, itemCategory, metadata, data.ochre.persistentUrl, belongsTo);
 				break;
 			default: throw new Error("Invalid category");
 		}
@@ -3628,6 +3603,7 @@ async function fetchWebsite(abbreviation, options) {
 		const isVersion2 = cleanAbbreviation.endsWith("-v2") ? true : options?.isVersion2 ?? false;
 		let metadata = null;
 		let tree = null;
+		let belongsTo = null;
 		if (isVersion2) {
 			const response = await (customFetch ?? fetch)(`https://ochre.lib.uchicago.edu/ochre/v2/ochre.php?xquery=${encodeURIComponent(`collection('ochre/tree')/ochre[tree/identification/abbreviation/content/string='${cleanAbbreviation.replace("-v2", "")}']`)}&format=json&lang="*"`);
 			if (!response.ok) throw new Error("Failed to fetch website");
@@ -3635,6 +3611,10 @@ async function fetchWebsite(abbreviation, options) {
 			if (Array.isArray(data.result) || !("tree" in data.result.ochre)) throw new Error("Failed to fetch website");
 			metadata = data.result.ochre.metadata;
 			tree = data.result.ochre.tree;
+			belongsTo = {
+				uuid: data.result.ochre.uuidBelongsTo,
+				abbreviation: parseFakeString(data.result.ochre.belongsTo)
+			};
 		} else {
 			const uuid = KNOWN_ABBREVIATIONS[cleanAbbreviation];
 			const response = await (customFetch ?? fetch)(uuid != null ? `https://ochre.lib.uchicago.edu/ochre?uuid=${uuid}&format=json` : `https://ochre.lib.uchicago.edu/ochre?xquery=${encodeURIComponent(`for $q in input()/ochre[tree[@type='lesson'][identification/abbreviation='${cleanAbbreviation}']] return $q`)}&format=json`);
@@ -3644,9 +3624,12 @@ async function fetchWebsite(abbreviation, options) {
 			if (result == null || !("tree" in result.ochre)) throw new Error("Failed to fetch website");
 			metadata = result.ochre.metadata;
 			tree = result.ochre.tree;
+			belongsTo = {
+				uuid: result.ochre.uuidBelongsTo,
+				abbreviation: parseFakeString(result.ochre.belongsTo)
+			};
 		}
-		const projectIdentification = metadata.project?.identification ? parseIdentification(metadata.project.identification) : null;
-		return [null, parseWebsite(tree, projectIdentification?.label ?? "", metadata.project?.identification.website ?? null, { isVersion2 })];
+		return [null, parseWebsite(tree, metadata, belongsTo, { isVersion2 })];
 	} catch (error) {
 		console.error(error);
 		return [error instanceof Error ? error.message : "Unknown error", null];

package/package.json

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