@digitalculture/ochre-sdk 0.17.2 → 0.17.4

package/dist/index.mjs

@@ -3606,7 +3606,7 @@ const responseItemSchema = z.object({
 /**
 * Schema for the OCHRE API response
 */
-const responseSchema = z.object({ result: z.object({ item: z.union([responseItemSchema, z.array(responseItemSchema)]) }) });
+const responseSchema = z.object({ result: z.object({ ochre: z.object({ item: z.union([responseItemSchema, z.array(responseItemSchema)]) }) }) });
 /**
 * Build an XQuery string to fetch property query items from the OCHRE API
 * @param scopeUuids - An array of scope UUIDs to filter by
@@ -3614,16 +3614,17 @@ const responseSchema = z.object({ result: z.object({ item: z.union([responseItem
 * @param projectScopeUuid - The UUID of the project scope
 * @returns An XQuery string
 */
-function buildXQuery(scopeUuids, propertyUuids, projectScopeUuid) {
+function buildXQuery(scopeUuids, propertyUuids, projectScopeUuid, options) {
+	const version = options?.version ?? DEFAULT_API_VERSION;
 	let collectionScopeFilter = "";
 	if (scopeUuids.length > 0) collectionScopeFilter = `[properties/property[label/@uuid="${BELONG_TO_COLLECTION_UUID}"][value[${scopeUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ")}]]]`;
 	const propertyFilters = propertyUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ");
-	return `for $q in input()/ochre[@uuidBelongsTo="${projectScopeUuid}"]/*${collectionScopeFilter}/properties//property[label[${propertyFilters}]]
+	return `<ochre>{${`for $q in ${version === 2 ? "doc()" : "input()"}/ochre[@uuidBelongsTo="${projectScopeUuid}"]/*${collectionScopeFilter}/properties//property[label[${propertyFilters}]]
 return <item>
 <property>{xs:string($q/label/@uuid)}</property>
 <value> {$q/*[2]/@*} {$q/*[2]/content[1]/string/text()} </value>
 <category> {$q/ancestor::node()[local-name(.)="properties"]/../@uuid}  {local-name($q/ancestor::node()[local-name(.)="properties"]/../self::node())} </category>
-</item>`;
+</item>`}}</ochre>`;
 }
 /**
 * Fetches and parses a property query from the OCHRE API
@@ -3656,12 +3657,12 @@ async function fetchPropertyQuery(params, options) {
 		const customFetch = options?.customFetch;
 		const version = options?.version ?? DEFAULT_API_VERSION;
 		const { scopeUuids, propertyUuids, projectScopeUuid } = params;
-		const xquery = buildXQuery(scopeUuids, propertyUuids, projectScopeUuid);
+		const xquery = buildXQuery(scopeUuids, propertyUuids, projectScopeUuid, { version });
 		const response = await (customFetch ?? fetch)(version === 2 ? `https://ochre.lib.uchicago.edu/ochre/v2/ochre.php?xquery=${encodeURIComponent(xquery)}&format=json&lang="*"` : `https://ochre.lib.uchicago.edu/ochre?xquery=${encodeURIComponent(xquery)}&format=json&lang="*"`);
 		if (!response.ok) throw new Error(`OCHRE API responded with status: ${response.status}`);
 		const data = await response.json();
 		const parsedResultRaw = responseSchema.parse(data);
-		const parsedItems = Array.isArray(parsedResultRaw.result.item) ? parsedResultRaw.result.item : [parsedResultRaw.result.item];
+		const parsedItems = Array.isArray(parsedResultRaw.result.ochre.item) ? parsedResultRaw.result.ochre.item : [parsedResultRaw.result.ochre.item];
 		const items = {};
 		for (const item of parsedItems) {
 			const categoryUuid = item.category.uuid;

package/package.json

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