ochre-sdk 1.0.6 → 1.0.8

package/dist/index.d.mts

@@ -1044,9 +1044,11 @@ declare function fetchGallery<const TLanguages extends ReadonlyArray<string> | u
 }, options?: FetchGalleryBaseOptions<TLanguages>): Promise<{
   gallery: Gallery<FetchGalleryLanguages<TLanguages>>;
   error: null;
+  detailedError: null;
 } | {
   gallery: null;
   error: string;
+  detailedError: string;
 }>;
 //#endregion
 //#region src/fetchers/item-links.d.ts
@@ -1071,9 +1073,11 @@ declare function fetchItemLinks<const TContainedItemCategory extends ContainedIt
 }): Promise<{
   items: Array<Item<ItemCategory, ContainedItemCategoryFromOption<ItemCategory, TContainedItemCategory>, FetchItemLinksLanguages<TLanguages>, "embedded">>;
   error: null;
+  detailedError: null;
 } | {
   items: null;
   error: string;
+  detailedError: string;
 }>;
 //#endregion
 //#region src/fetchers/item.d.ts
@@ -1115,9 +1119,11 @@ declare function fetchItem<const TContainedItemCategory extends ContainedItemCat
 }): Promise<{
   item: Item<ItemCategory, ContainedItemCategoryFromOption<ItemCategory, TContainedItemCategory>, FetchItemLanguages<TLanguages>>;
   error: null;
+  detailedError: null;
 } | {
   item: null;
   error: string;
+  detailedError: string;
 }>;
 declare function fetchItem<const TCategory extends ItemContainerCategory, const TContainedItemCategory extends ContainedItemCategoryOption<TCategory> | undefined = undefined, const TLanguages extends ReadonlyArray<string> | undefined = undefined>(uuid: string, options: FetchItemBaseOptions<TLanguages> & {
   category: TCategory;
@@ -1125,9 +1131,11 @@ declare function fetchItem<const TCategory extends ItemContainerCategory, const
 }): Promise<{
   item: Item<TCategory, ContainedItemCategoryFromOption<TCategory, TContainedItemCategory>, FetchItemLanguages<TLanguages>>;
   error: null;
+  detailedError: null;
 } | {
   item: null;
   error: string;
+  detailedError: string;
 }>;
 declare function fetchItem<const TCategory extends ItemCategory, const TLanguages extends ReadonlyArray<string> | undefined = undefined>(uuid: string, options: FetchItemBaseOptions<TLanguages> & {
   category: TCategory;
@@ -1135,9 +1143,11 @@ declare function fetchItem<const TCategory extends ItemCategory, const TLanguage
 }): Promise<{
   item: Item<TCategory, ContainedItemCategory<TCategory>, FetchItemLanguages<TLanguages>>;
   error: null;
+  detailedError: null;
 } | {
   item: null;
   error: string;
+  detailedError: string;
 }>;
 //#endregion
 //#region src/fetchers/set/items.d.ts
@@ -1175,12 +1185,14 @@ declare function fetchSetItems<const TContainedItemCategories extends ReadonlyAr
   pageSize: number;
   items: Array<SetItem<FetchSetItemsCategory<TContainedItemCategories>, FetchSetItemsLanguages<TLanguages>>>;
   error: null;
+  detailedError: null;
 } | {
   totalCount: null;
   page: null;
   pageSize: null;
   items: null;
   error: string;
+  detailedError: string;
 }>;
 //#endregion
 //#region src/fetchers/set/property-values.d.ts
@@ -1217,11 +1229,13 @@ declare function fetchSetPropertyValues(params: {
     periods: Array<SetAttributeValueQueryItem> | null;
   };
   error: null;
+  detailedError: null;
 } | {
   propertyValues: null;
   propertyValuesByPropertyVariableUuid: null;
   attributeValues: null;
   error: string;
+  detailedError: string;
 }>;
 //#endregion
 //#region src/types/website.d.ts
@@ -1734,9 +1748,11 @@ declare function fetchWebsite<const T extends LanguageCodes = LanguageCodes>(abb
 }): Promise<{
   website: Website<T>;
   error: null;
+  detailedError: null;
 } | {
   website: null;
   error: string;
+  detailedError: string;
 }>;
 //#endregion
 //#region src/getters.d.ts

package/dist/index.mjs

@@ -488,6 +488,138 @@ var MultilingualString = class MultilingualString {
 //#endregion
 //#region src/utils.ts
 const PSEUDO_UUID_REGEX = /^[\da-f]{8}(?:-[\da-f]{4}){3}-[\da-f]{12}$/i;
+function isRecord$5(value) {
+	return typeof value === "object" && value != null;
+}
+function isSchemaValidationIssue(value) {
+	if (!isRecord$5(value)) return false;
+	return typeof value.kind === "string" && typeof value.type === "string" && typeof value.message === "string";
+}
+function isSchemaValidationIssues(value) {
+	if (!Array.isArray(value) || value.length === 0) return false;
+	for (const item of value) if (!isSchemaValidationIssue(item)) return false;
+	return true;
+}
+function getIssuePath(issue) {
+	const path = v.getDotPath(issue);
+	return path != null && path.length > 0 ? path : "(root)";
+}
+function formatPrimitiveValue(value) {
+	if (value == null) return String(value);
+	if (typeof value === "string") return JSON.stringify(value);
+	if (typeof value === "number" || typeof value === "boolean" || typeof value === "bigint" || typeof value === "symbol") return String(value);
+	if (value instanceof Date) return value.toISOString();
+	if (value instanceof RegExp) return String(value);
+	return null;
+}
+function appendSchemaValidationIssues(lines, issues, depth = 0, prefix = "") {
+	let index = 0;
+	for (const issue of issues) {
+		index += 1;
+		const number = prefix.length > 0 ? `${prefix}.${index}` : String(index);
+		const indent = "  ".repeat(depth);
+		lines.push(`${indent}${number}. ${getIssuePath(issue)}`, `${indent}   Message: ${issue.message}`, `${indent}   Type: ${issue.kind}:${issue.type}`);
+		if (issue.expected != null) lines.push(`${indent}   Expected: ${issue.expected}`);
+		if (issue.received.length > 0) lines.push(`${indent}   Received: ${issue.received}`);
+		const input = formatPrimitiveValue(issue.input);
+		if (input != null) lines.push(`${indent}   Input: ${input}`);
+		const requirement = formatPrimitiveValue(issue.requirement);
+		if (requirement != null) lines.push(`${indent}   Requirement: ${requirement}`);
+		if (issue.issues != null && issue.issues.length > 0) {
+			lines.push(`${indent}   Nested issues:`);
+			appendSchemaValidationIssues(lines, issue.issues, depth + 1, number);
+		}
+	}
+}
+function formatCauseValue(value) {
+	if (typeof value === "string") return value.length > 0 ? value : null;
+	const primitiveValue = formatPrimitiveValue(value);
+	if (primitiveValue != null) return primitiveValue;
+	if (Array.isArray(value)) {
+		const values = [];
+		for (const item of value) {
+			const formattedItem = typeof item === "string" && item.length > 0 ? item : formatPrimitiveValue(item);
+			if (formattedItem != null && formattedItem.length > 0) values.push(formattedItem);
+		}
+		return values.length > 0 ? values.join(", ") : null;
+	}
+	if (isRecord$5(value)) {
+		const values = [];
+		for (const [key, entryValue] of Object.entries(value)) {
+			const formattedEntryValue = formatPrimitiveValue(entryValue);
+			if (formattedEntryValue != null) values.push(`${key}: ${formattedEntryValue}`);
+		}
+		return values.length > 0 ? values.join("; ") : null;
+	}
+	return null;
+}
+function appendDetailedError(lines, error, fallbackMessage, depth, seenErrors) {
+	const indent = "  ".repeat(depth);
+	if (error instanceof Error) {
+		if (seenErrors.has(error)) {
+			lines.push(`${indent}Error: [Circular cause]`);
+			return;
+		}
+		seenErrors.add(error);
+		lines.push(`${indent}Error`);
+		if (error.name !== "Error") lines.push(`${indent}Name: ${error.name}`);
+		lines.push(`${indent}Message: ${error.message}`);
+		if (error instanceof AggregateError && error.errors.length > 0) {
+			lines.push("", `${indent}Contained errors`);
+			let index = 0;
+			for (const containedError of error.errors) {
+				index += 1;
+				lines.push(`${indent}${index}.`);
+				appendDetailedError(lines, containedError, "Unknown error", depth + 1, seenErrors);
+			}
+		}
+		if (error.cause != null) {
+			const causeLines = [];
+			if (appendDetailedCause(causeLines, error.cause, depth, seenErrors)) lines.push("", ...causeLines);
+		}
+		return;
+	}
+	lines.push(`${indent}Error`, `${indent}Message: ${fallbackMessage}`);
+	const value = formatCauseValue(error);
+	if (value != null) lines.push(`${indent}Value: ${value}`);
+}
+function appendDetailedCause(lines, cause, depth, seenErrors) {
+	const indent = "  ".repeat(depth);
+	if (isSchemaValidationIssues(cause)) {
+		lines.push(`${indent}Schema validation`);
+		appendSchemaValidationIssues(lines, cause, depth);
+		return true;
+	}
+	if (cause instanceof Error) {
+		lines.push(`${indent}Cause`);
+		appendDetailedError(lines, cause, cause.message, depth + 1, seenErrors);
+		return true;
+	}
+	const formattedCause = formatCauseValue(cause);
+	if (formattedCause != null) {
+		lines.push(`${indent}Cause`, `${indent}${formattedCause}`);
+		return true;
+	}
+	return false;
+}
+function getErrorMessage(error, fallbackMessage) {
+	return error instanceof Error ? error.message : fallbackMessage;
+}
+function getDetailedError(error, fallbackMessage = "Unknown error") {
+	const lines = [];
+	appendDetailedError(lines, error, fallbackMessage, 0, /* @__PURE__ */ new Set());
+	return lines.join("\n");
+}
+function getErrorOutput(error, fallbackMessage) {
+	const message = getErrorMessage(error, fallbackMessage);
+	return {
+		error: message,
+		detailedError: getDetailedError(error, message)
+	};
+}
+function createSchemaValidationError(message, issues) {
+	return new Error(message, { cause: issues });
+}
 /**
 * Logs Valibot validation issues to the console with detailed formatting
 * @param issues - The validation issues to log
@@ -3636,18 +3768,19 @@ async function fetchGallery(params, options) {
 		const { success, issues, output } = v.safeParse(XMLGalleryData, data);
 		if (!success) {
 			logIssues(issues);
-			throw new Error("Failed to parse gallery XML", { cause: issues });
+			throw createSchemaValidationError("Failed to parse gallery XML", issues);
 		}
 		restoreXMLMetadata(output, data);
 		return {
 			gallery: parseGallery(output, { languages: resolveGalleryLanguages(output, requestedLanguages) }),
-			error: null
+			error: null,
+			detailedError: null
 		};
 	} catch (error) {
 		console.error(error);
 		return {
 			gallery: null,
-			error: error instanceof Error ? error.message : "Failed to fetch gallery"
+			...getErrorOutput(error, "Failed to fetch gallery")
 		};
 	}
 }
@@ -3746,7 +3879,7 @@ async function fetchItemLinks(uuid, options) {
 		const { success, issues, output } = v.safeParse(XMLItemLinksData, data);
 		if (!success) {
 			logIssues(issues);
-			throw new Error("Failed to parse OCHRE item links", { cause: issues });
+			throw createSchemaValidationError("Failed to parse OCHRE item links", issues);
 		}
 		restoreXMLMetadata(output, data);
 		const languages = resolveItemLinksLanguages(output, requestedLanguages);
@@ -3755,13 +3888,14 @@ async function fetchItemLinks(uuid, options) {
 				containedItemCategory: options?.containedItemCategory,
 				languages
 			}),
-			error: null
+			error: null,
+			detailedError: null
 		};
 	} catch (error) {
 		console.error(error);
 		return {
 			items: null,
-			error: error instanceof Error ? error.message : "Unknown error"
+			...getErrorOutput(error, "Unknown error")
 		};
 	}
 }
@@ -3847,7 +3981,7 @@ async function fetchItem(uuid, options) {
 		const { success, issues, output } = v.safeParse(XMLData, data);
 		if (!success) {
 			logIssues(issues);
-			throw new Error("Failed to parse OCHRE data", { cause: issues });
+			throw createSchemaValidationError("Failed to parse OCHRE data", issues);
 		}
 		restoreXMLMetadata(output, data);
 		const category = options?.category ?? inferFetchItemCategory(output.result.ochre);
@@ -3858,13 +3992,14 @@ async function fetchItem(uuid, options) {
 				containedItemCategory: options?.containedItemCategory,
 				languages
 			}),
-			error: null
+			error: null,
+			detailedError: null
 		};
 	} catch (error) {
 		console.error(error);
 		return {
 			item: null,
-			error: error instanceof Error ? error.message : "Unknown error"
+			...getErrorOutput(error, "Unknown error")
 		};
 	}
 }
@@ -4921,7 +5056,7 @@ async function fetchSetItems(params, containedItemCategories, options) {
 		const { success, issues, output } = v.safeParse(XMLSetItemsData, data);
 		if (!success) {
 			logIssues(issues);
-			throw new Error("Failed to parse OCHRE Set items", { cause: issues });
+			throw createSchemaValidationError("Failed to parse OCHRE Set items", issues);
 		}
 		restoreXMLMetadata(output, data);
 		if (containedItemCategories != null) {
@@ -4941,7 +5076,8 @@ async function fetchSetItems(params, containedItemCategories, options) {
 			page: output.result.ochre.items.page,
 			pageSize: output.result.ochre.items.pageSize,
 			items: uniqueItems,
-			error: null
+			error: null,
+			detailedError: null
 		};
 	} catch (error) {
 		console.error(error);
@@ -4950,7 +5086,7 @@ async function fetchSetItems(params, containedItemCategories, options) {
 			page: null,
 			pageSize: null,
 			items: null,
-			error: error instanceof Error ? error.message : "Failed to fetch Set items"
+			...getErrorOutput(error, "Failed to fetch Set items")
 		};
 	}
 }
@@ -5377,7 +5513,8 @@ async function fetchSetPropertyValues(params, options) {
 				bibliographies: null,
 				periods: null
 			},
-			error: null
+			error: null,
+			detailedError: null
 		};
 		const xquery = buildXQuery({
 			setScopeUuids,
@@ -5398,7 +5535,7 @@ async function fetchSetPropertyValues(params, options) {
 		const { success, issues, output } = v.safeParse(responseSchema, data);
 		if (!success) {
 			logIssues(issues);
-			throw new Error("Failed to parse OCHRE Set property values", { cause: issues });
+			throw createSchemaValidationError("Failed to parse OCHRE Set property values", issues);
 		}
 		const parsedPropertyValues = [];
 		const parsedAttributeValues = [];
@@ -5449,7 +5586,8 @@ async function fetchSetPropertyValues(params, options) {
 				bibliographies: attributes.bibliographies ? sortAttributeValues(attributeValuesByType.bibliographies) : null,
 				periods: attributes.periods ? sortAttributeValues(attributeValuesByType.periods) : null
 			},
-			error: null
+			error: null,
+			detailedError: null
 		};
 	} catch (error) {
 		console.error(error);
@@ -5457,7 +5595,7 @@ async function fetchSetPropertyValues(params, options) {
 			propertyValues: null,
 			propertyValuesByPropertyVariableUuid: null,
 			attributeValues: null,
-			error: error instanceof Error ? error.message : "Failed to fetch property values"
+			...getErrorOutput(error, "Failed to fetch property values")
 		};
 	}
 }
@@ -7126,18 +7264,19 @@ async function fetchWebsite(abbreviation, options) {
 		const { success, issues, output } = v.safeParse(XMLWebsiteData, data);
 		if (!success) {
 			logIssues(issues);
-			throw new Error("Failed to parse website XML", { cause: issues });
+			throw createSchemaValidationError("Failed to parse website XML", issues);
 		}
 		restoreXMLMetadata(output, data);
 		return {
 			website: parseWebsite(output, { languages: options?.languages }),
-			error: null
+			error: null,
+			detailedError: null
 		};
 	} catch (error) {
 		console.error(error);
 		return {
 			website: null,
-			error: error instanceof Error ? error.message : "Unknown error"
+			...getErrorOutput(error, "Unknown error")
 		};
 	}
 }

package/package.json

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