@digitalculture/ochre-sdk 0.13.2 → 0.13.4

package/dist/index.d.mts

@@ -2,7 +2,7 @@
 /**
  * Represents the core data structure containing item information and metadata
  */
-type Data<T extends DataCategory = DataCategory, U extends DataCategory = (T extends "tree" | "set" ? DataCategory : never)> = {
+type Data<T extends DataCategory = DataCategory, U extends DataCategory = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? DataCategory : never)> = {
   uuid: string;
   belongsTo: {
     uuid: string;
@@ -16,9 +16,9 @@ type Data<T extends DataCategory = DataCategory, U extends DataCategory = (T ext
  */
 type DataCategory = "tree" | "set" | "resource" | "spatialUnit" | "concept" | "period" | "bibliography" | "person" | "propertyValue";
 /**
- * Represents the item of the data
+ * Represents the item of the data, with proper type narrowing based on category
  */
-type Item<T extends DataCategory = DataCategory, U extends DataCategory = (T extends "tree" | "set" ? DataCategory : never)> = Tree<T, U> | Set<U> | Resource | SpatialUnit | Concept | Period | Bibliography | Person | PropertyValue;
+type Item<T extends DataCategory = DataCategory, U extends DataCategory = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? DataCategory : never)> = T extends "resource" ? Resource : T extends "spatialUnit" ? SpatialUnit : T extends "concept" ? Concept : T extends "period" ? Period : T extends "bibliography" ? Bibliography : T extends "person" ? Person : T extends "propertyValue" ? PropertyValue : T extends "tree" ? Tree<Exclude<U, "tree">> : T extends "set" ? Set<U> : Resource | SpatialUnit | Concept | Period | Bibliography | Person | PropertyValue | Tree<Exclude<U, "tree">> | Set<U>;
 /**
  * Basic identification information used across multiple types
  */
@@ -354,11 +354,11 @@ type Concept = {
 /**
  * Represents a set that can contain resources, spatial units and concepts
  */
-type Set<T extends DataCategory> = {
+type Set<U extends DataCategory = DataCategory> = {
   uuid: string;
   category: "set";
   metadata: Metadata | null;
-  itemCategory: T;
+  itemCategory: U;
   publicationDateTime: Date | null;
   type: string;
   number: number;
@@ -368,7 +368,7 @@ type Set<T extends DataCategory> = {
   isSuppressingBlanks: boolean;
   description: string;
   creators: Array<Person>;
-  items: T extends "resource" ? Array<Resource> : T extends "spatialUnit" ? Array<SpatialUnit> : T extends "concept" ? Array<Concept> : T extends "period" ? Array<Period> : T extends "bibliography" ? Array<Bibliography> : T extends "person" ? Array<Person> : T extends "propertyValue" ? Array<PropertyValue> : never;
+  items: [DataCategory] extends [U] ? Array<Item> : U extends "resource" ? Array<Resource> : U extends "spatialUnit" ? Array<SpatialUnit> : U extends "concept" ? Array<Concept> : U extends "period" ? Array<Period> : U extends "bibliography" ? Array<Bibliography> : U extends "person" ? Array<Person> : U extends "propertyValue" ? Array<PropertyValue> : U extends "tree" ? Array<Tree<Exclude<DataCategory, "tree">>> : U extends "set" ? Array<Set<DataCategory>> : Array<Item>;
 };
 /**
  * Represents a bibliography entry with citation and publication information
@@ -467,7 +467,7 @@ type Property<T extends PropertyValueContentType = PropertyValueContentType> = {
 /**
  * Represents a tree structure containing resources, spatial units and concepts
  */
-type Tree<T extends DataCategory, U extends DataCategory> = {
+type Tree<U extends Exclude<DataCategory, "tree"> = Exclude<DataCategory, "tree">> = {
   uuid: string;
   category: "tree";
   metadata: Metadata | null;
@@ -479,7 +479,7 @@ type Tree<T extends DataCategory, U extends DataCategory> = {
   identification: Identification;
   creators: Array<Person>;
   properties: Array<Property>;
-  items: T extends "resource" ? Array<Resource> : T extends "spatialUnit" ? Array<SpatialUnit> : T extends "concept" ? Array<Concept> : T extends "period" ? Array<Period> : T extends "bibliography" ? Array<Bibliography> : T extends "person" ? Array<Person> : T extends "propertyValue" ? Array<PropertyValue> : T extends "set" ? Array<Set<U>> : never;
+  items: [Exclude<DataCategory, "tree">] extends [U] ? Array<Item> : U extends "resource" ? Array<Resource> : U extends "spatialUnit" ? Array<SpatialUnit> : U extends "concept" ? Array<Concept> : U extends "period" ? Array<Period> : U extends "bibliography" ? Array<Bibliography> : U extends "person" ? Array<Person> : U extends "propertyValue" ? Array<PropertyValue> : U extends "set" ? Array<Set<DataCategory>> : Array<Item>;
 };
 /**
  * Represents a gallery with its identification, project identification, resources and max length
@@ -959,24 +959,24 @@ 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, setCategory?: 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" ? U : never, options?: {
   customFetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
   isVersion2: boolean;
 }): Promise<{
   error: null;
-  metadata: Metadata;
   belongsTo: {
     uuid: string;
     abbreviation: string;
   };
   item: Item<T, U>;
   category: T;
+  itemCategory: T extends "tree" ? Exclude<U, "tree"> : T extends "set" ? U : never;
 } | {
   error: string;
-  metadata: never;
   belongsTo: never;
   item: never;
   category: never;
+  itemCategory: never;
 }>;
 //#endregion
 //#region src/utils/fetchers/property-query.d.ts

package/dist/index.mjs

@@ -1404,13 +1404,13 @@ function parsePropertyValues(propertyValues) {
 * @param tree - Raw tree data in OCHRE format
 * @returns Parsed Tree object or null if invalid
 */
-function parseTree(tree, itemCategory, itemSubCategory, metadata) {
+function parseTree(tree, itemCategory, metadata) {
 	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]);
 	let date = null;
 	if (tree.date != null) date = tree.date;
-	const parsedItemCategory = itemSubCategory ?? getItemCategory(Object.keys(tree.items));
+	const parsedItemCategory = itemCategory ?? getItemCategory(Object.keys(tree.items));
 	let items = [];
 	switch (parsedItemCategory) {
 		case "resource":
@@ -1444,7 +1444,7 @@ function parseTree(tree, itemCategory, itemSubCategory, 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, itemSubCategory));
+			for (const item of Array.isArray(tree.items.set) ? tree.items.set : [tree.items.set]) setItems.push(parseSet(item, itemCategory));
 			items = setItems;
 			break;
 		}
@@ -2920,7 +2920,7 @@ async function fetchByUuid(uuid, options) {
 *
 * If the fetch/parse fails, the returned object will have an `error` property.
 */
-async function fetchItem(uuid, category, setCategory, options) {
+async function fetchItem(uuid, category, itemCategory, options) {
 	try {
 		const customFetch = options?.customFetch;
 		const [error, data] = await fetchByUuid(uuid, {
@@ -2962,42 +2962,35 @@ async function fetchItem(uuid, category, setCategory, options) {
 				break;
 			case "set":
 				if (!("set" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'set' key");
-				item = parseSet(data.ochre.set, setCategory, metadata);
+				item = parseSet(data.ochre.set, itemCategory, metadata);
 				break;
 			case "tree":
 				if (!("tree" in data.ochre)) throw new Error("Invalid OCHRE data: API response missing 'tree' key");
-				item = parseTree(data.ochre.tree, category, setCategory, metadata);
+				item = parseTree(data.ochre.tree, itemCategory, metadata);
 				break;
 			default: throw new Error("Invalid category");
 		}
 		return {
 			error: null,
-			metadata,
 			belongsTo: {
 				uuid: data.ochre.uuidBelongsTo,
 				abbreviation: parseFakeString(data.ochre.belongsTo)
 			},
 			item,
-			category
+			category,
+			itemCategory
 		};
 	} catch (error) {
 		return {
 			error: error instanceof Error ? error.message : "Unknown error",
-			metadata: void 0,
 			belongsTo: void 0,
 			item: void 0,
-			category: void 0
+			category: void 0,
+			itemCategory: void 0
 		};
 	}
 }
 
-//#endregion
-//#region src/constants.ts
-/**
-* The UUID of the `<unassigned>` property value in OCHRE
-*/
-const UNASSIGNED_UUID = "e28e29af-b663-c0ac-ceb6-11a688fca0dd";
-
 //#endregion
 //#region src/utils/fetchers/property-query.ts
 const PROJECT_SCOPE = "0c0aae37-7246-495b-9547-e25dbf5b99a3";
@@ -3104,7 +3097,7 @@ async function fetchPropertyQuery(scopeUuids, propertyUuids, options) {
 			};
 		}
 		return {
-			items: Object.values(items).filter((result) => result.value.uuid !== UNASSIGNED_UUID).toSorted((a, b) => {
+			items: Object.values(items).toSorted((a, b) => {
 				const aValue = a.value.label ?? a.value.content;
 				const bValue = b.value.label ?? b.value.content;
 				return aValue.localeCompare(bValue, "en-US");

package/package.json

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