@digitalculture/ochre-sdk 0.14.11 → 0.15.0

package/dist/index.d.mts

@@ -367,7 +367,7 @@ type Set<U extends DataCategory = DataCategory> = {
   uuid: string;
   category: "set";
   metadata: Metadata | null;
-  itemCategory: U;
+  itemCategories: Array<U>;
   publicationDateTime: Date | null;
   type: string;
   number: number;
@@ -1017,7 +1017,7 @@ declare function fetchGallery(uuid: string, filter: string, page: number, perPag
  *
  * If the fetch/parse fails, the returned object will have an `error` property.
  */
-declare function fetchItem<T extends DataCategory, U extends DataCategory>(uuid: string, category?: T, itemCategory?: T extends "tree" ? Exclude<U, "tree"> : T extends "set" ? U : never, options?: {
+declare function fetchItem<T extends DataCategory, U extends DataCategory>(uuid: string, category?: T, itemCategory?: T extends "tree" ? Exclude<U, "tree"> : T extends "set" ? Array<U> : never, options?: {
   customFetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
   isVersion2: boolean;
 }): Promise<{
@@ -1028,7 +1028,7 @@ declare function fetchItem<T extends DataCategory, U extends DataCategory>(uuid:
   };
   item: Item<T, U>;
   category: T;
-  itemCategory: T extends "tree" ? Exclude<U, "tree"> : T extends "set" ? U : never;
+  itemCategory: T extends "tree" ? Exclude<U, "tree"> : T extends "set" ? Array<U> : never;
 } | {
   error: string;
   belongsTo: never;

package/dist/index.mjs

@@ -771,6 +771,17 @@ function getItemCategory(keys) {
 	}
 	return categorySchema.parse(categoryFound);
 }
+/**
+* Get the categories of items from the OCHRE API response
+* @param keys - The keys of the OCHRE API response
+* @returns The categories of the items
+* @internal
+*/
+function getItemCategories(keys) {
+	const categories = keys.map((key) => categorySchema.safeParse(key));
+	if (categories.some((result) => !result.success)) throw new Error(`Invalid OCHRE data; found unexpected keys: ${categories.filter((result) => !result.success).map((result) => result.error.message).join(", ")}`);
+	return categories.filter((result) => result.success).map((result) => result.data);
+}
 
 //#endregion
 //#region src/utils/parse.ts
@@ -1606,7 +1617,7 @@ function parseTree(tree, itemCategory, metadata) {
 		case "set": {
 			if (!("set" in tree.items)) throw new Error("Invalid OCHRE data: Tree has no sets");
 			const setItems = [];
-			for (const item of Array.isArray(tree.items.set) ? tree.items.set : [tree.items.set]) setItems.push(parseSet(item, itemCategory));
+			for (const item of Array.isArray(tree.items.set) ? tree.items.set : [tree.items.set]) setItems.push(parseSet(item, [itemCategory]));
 			items = setItems;
 			break;
 		}
@@ -1633,41 +1644,41 @@ function parseTree(tree, itemCategory, metadata) {
 * @param set - Raw set data in OCHRE format
 * @returns Parsed Set object
 */
-function parseSet(set, itemCategory, metadata) {
+function parseSet(set, itemCategories, metadata) {
 	if (typeof set.items === "string") throw new TypeError("Invalid OCHRE data: Set has no items");
-	const parsedItemCategory = itemCategory ?? getItemCategory(Object.keys(set.items));
+	const parsedItemCategories = itemCategories ?? getItemCategories(Object.keys(set.items));
 	let items = [];
-	switch (parsedItemCategory) {
+	for (const itemCategory of parsedItemCategories) switch (itemCategory) {
 		case "resource":
-			if (!("resource" in set.items)) throw new Error("Invalid OCHRE data: Set has no resources");
+			if (!("resource" in set.items) || set.items.resource == null) throw new Error("Invalid OCHRE data: Set has no resources");
 			items = parseResources(Array.isArray(set.items.resource) ? set.items.resource : [set.items.resource]);
 			break;
 		case "spatialUnit":
-			if (!("spatialUnit" in set.items)) throw new Error("Invalid OCHRE data: Set has no spatial units");
+			if (!("spatialUnit" in set.items) || set.items.spatialUnit == null) throw new Error("Invalid OCHRE data: Set has no spatial units");
 			items = parseSpatialUnits(Array.isArray(set.items.spatialUnit) ? set.items.spatialUnit : [set.items.spatialUnit]);
 			break;
 		case "concept":
-			if (!("concept" in set.items)) throw new Error("Invalid OCHRE data: Set has no concepts");
+			if (!("concept" in set.items) || set.items.concept == null) throw new Error("Invalid OCHRE data: Set has no concepts");
 			items = parseConcepts(Array.isArray(set.items.concept) ? set.items.concept : [set.items.concept]);
 			break;
 		case "period":
-			if (!("period" in set.items)) throw new Error("Invalid OCHRE data: Set has no periods");
+			if (!("period" in set.items) || set.items.period == null) throw new Error("Invalid OCHRE data: Set has no periods");
 			items = parsePeriods(Array.isArray(set.items.period) ? set.items.period : [set.items.period]);
 			break;
 		case "bibliography":
-			if (!("bibliography" in set.items)) throw new Error("Invalid OCHRE data: Set has no bibliographies");
+			if (!("bibliography" in set.items) || set.items.bibliography == null) throw new Error("Invalid OCHRE data: Set has no bibliographies");
 			items = parseBibliographies(Array.isArray(set.items.bibliography) ? set.items.bibliography : [set.items.bibliography]);
 			break;
 		case "person":
-			if (!("person" in set.items)) throw new Error("Invalid OCHRE data: Set has no persons");
+			if (!("person" in set.items) || set.items.person == null) throw new Error("Invalid OCHRE data: Set has no persons");
 			items = parsePersons(Array.isArray(set.items.person) ? set.items.person : [set.items.person]);
 			break;
 		case "propertyValue":
-			if (!("propertyValue" in set.items)) throw new Error("Invalid OCHRE data: Set has no property values");
+			if (!("propertyValue" in set.items) || set.items.propertyValue == null) throw new Error("Invalid OCHRE data: Set has no property values");
 			items = parsePropertyValues(Array.isArray(set.items.propertyValue) ? set.items.propertyValue : [set.items.propertyValue]);
 			break;
 		case "text":
-			if (!("text" in set.items)) throw new Error("Invalid OCHRE data: Set has no texts");
+			if (!("text" in set.items) || set.items.text == null) throw new Error("Invalid OCHRE data: Set has no texts");
 			items = parseTexts(Array.isArray(set.items.text) ? set.items.text : [set.items.text]);
 			break;
 		default: throw new Error("Invalid OCHRE data: Set has no items or is malformed");
@@ -1676,7 +1687,7 @@ function parseSet(set, itemCategory, metadata) {
 		uuid: set.uuid,
 		category: "set",
 		metadata: metadata ?? null,
-		itemCategory,
+		itemCategories: parsedItemCategories,
 		publicationDateTime: set.publicationDateTime ? new Date(set.publicationDateTime) : null,
 		date: set.date ?? null,
 		license: parseLicense(set.availability),

package/package.json

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