ochre-sdk 0.22.7 → 0.22.9

package/dist/index.d.mts

@@ -802,6 +802,7 @@ type StylesheetCategory = Extract<DataCategory, "propertyVariable" | "propertyVa
 type StylesheetItem = {
   uuid: string;
   category: "propertyVariable";
+  icon: string | null;
   styles: {
     default: Array<Style>;
     tablet: Array<Style>;
@@ -811,6 +812,7 @@ type StylesheetItem = {
   uuid: string;
   category: "propertyValue";
   variableUuid: string;
+  icon: string | null;
   styles: {
     default: Array<Style>;
     tablet: Array<Style>;

package/dist/index.mjs

@@ -879,13 +879,6 @@ const setItemsSortSchema = z.discriminatedUnion("target", [
 		language: z.string().default("eng")
 	}).strict()
 ]).default({ target: "none" });
-function hasPropertyQueryWithPropertyVariable(query) {
-	if (query == null) return false;
-	if ("target" in query) return query.target === "property" && query.propertyVariable != null;
-	const groupQueries = "and" in query ? query.and : query.or;
-	for (const groupQuery of groupQueries) if (hasPropertyQueryWithPropertyVariable(groupQuery)) return true;
-	return false;
-}
 /**
 * Schema for validating the parameters for the Set property values fetching function
 * @internal
@@ -902,12 +895,6 @@ const setPropertyValuesParamsSchema = z.object({
 		periods: false
 	}),
 	isLimitedToLeafPropertyValues: z.boolean().default(false)
-}).superRefine((value, ctx) => {
-	if (!hasPropertyQueryWithPropertyVariable(value.queries)) ctx.addIssue({
-		code: "custom",
-		path: ["queries"],
-		message: "At least one property query with propertyVariable is required"
-	});
 });
 const setItemsParamsSchema = z.object({
 	setScopeUuids: z.array(uuidSchema).min(1, "At least one set scope UUID is required"),
@@ -3158,6 +3145,7 @@ const responseSchema = z.object({ result: z.union([z.object({ ochre: z.object({
 * @param params.setScopeUuids - An array of set scope UUIDs to filter by
 * @param params.belongsToCollectionScopeUuids - An array of collection scope UUIDs to filter by
 * @param params.queries - Recursive query tree used to filter matching items
+* @param params.propertyVariableUuids - Property variable UUIDs to aggregate, if any
 * @param params.attributes - Whether to return values for bibliographies and periods
 * @param params.attributes.bibliographies - Whether to return values for bibliographies
 * @param params.attributes.periods - Whether to return values for periods
@@ -3165,10 +3153,9 @@ const responseSchema = z.object({ result: z.union([z.object({ ochre: z.object({
 * @returns An XQuery string
 */
 function buildXQuery(params) {
-	const { setScopeUuids, belongsToCollectionScopeUuids, queries, attributes, isLimitedToLeafPropertyValues } = params;
+	const { setScopeUuids, belongsToCollectionScopeUuids, queries, propertyVariableUuids, attributes, isLimitedToLeafPropertyValues } = params;
 	let setScopeFilter = "/set/items/*";
 	if (setScopeUuids.length > 0) setScopeFilter = `/set[(${setScopeUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ")})]/items/*`;
-	const propertyVariableFilters = getPropertyVariableUuidsFromQueries(queries).map((uuid) => `@uuid="${uuid}"`).join(" or ");
 	const baseItemsExpression = `doc()/ochre${setScopeFilter}`;
 	const compiledQueryPlan = buildQueryPlan({ queries: getItemFilterQueriesFromPropertyValueQueries(queries) });
 	const itemsQueryExpressions = [];
@@ -3176,17 +3163,23 @@ function buildXQuery(params) {
 	if (compiledQueryPlan.queryExpression != null) itemsQueryExpressions.push(compiledQueryPlan.queryExpression);
 	if (belongsToCollectionQueryExpression != null) itemsQueryExpressions.push(belongsToCollectionQueryExpression);
 	const itemsQueryExpression = buildAndCtsQueryExpression(itemsQueryExpressions);
-	const queryBlocks = [`let $matching-props := $items//property[label[${propertyVariableFilters}]]
+	const valueFilter = isLimitedToLeafPropertyValues ? "[not(@i)]" : "";
+	const queryBlocks = [];
+	const returnedSequences = [];
+	if (propertyVariableUuids.length > 0) {
+		const propertyVariableFilters = propertyVariableUuids.map((uuid) => `@uuid="${uuid}"`).join(" or ");
+		queryBlocks.push(`let $matching-props := $items//property[label[${propertyVariableFilters}]]
 
 let $property-values :=
   for $p in $matching-props
-  for $v in $p/value${isLimitedToLeafPropertyValues ? "[not(@i)]" : ""}
+  for $v in $p/value${valueFilter}
     let $item-uuid := $v/ancestor::*[parent::items]/@uuid
     let $variable-uuid := $p/label/@uuid
     return <propertyValue uuid="{$v/@uuid}" rawValue="{$v/@rawValue}" dataType="{$v/@dataType}" itemUuid="{$item-uuid}" variableUuid="{$variable-uuid}">{
       if ($v/content) then string-join($v/content[@xml:lang="eng"]//text(), "") else $v/text()
-    }</propertyValue>`];
-	const returnedSequences = ["$property-values"];
+    }</propertyValue>`);
+		returnedSequences.push("$property-values");
+	}
 	if (attributes.bibliographies) {
 		queryBlocks.push(`let $bibliography-values :=
   for $item in $items
@@ -3231,10 +3224,21 @@ async function fetchSetPropertyValues(params, options) {
 	try {
 		if (options?.version != null && options.version !== 2) throw new Error("Set property value queries only support API version 2");
 		const { setScopeUuids, belongsToCollectionScopeUuids, queries, attributes, isLimitedToLeafPropertyValues } = setPropertyValuesParamsSchema.parse(params);
+		const propertyVariableUuids = getPropertyVariableUuidsFromQueries(queries);
+		if (propertyVariableUuids.length === 0 && !attributes.bibliographies && !attributes.periods) return {
+			propertyValues: [],
+			propertyValuesByPropertyVariableUuid: {},
+			attributeValues: {
+				bibliographies: null,
+				periods: null
+			},
+			error: null
+		};
 		const xquery = buildXQuery({
 			setScopeUuids,
 			belongsToCollectionScopeUuids,
 			queries,
+			propertyVariableUuids,
 			attributes,
 			isLimitedToLeafPropertyValues
 		});
@@ -3747,12 +3751,14 @@ function parseStylesheets(styles) {
 				uuid: style.valueUuid,
 				category: "propertyValue",
 				variableUuid: style.variableUuid,
+				icon: style.lucideIcon ?? null,
 				styles: stylesByViewport
 			};
 		}
 		return {
 			uuid: style.variableUuid,
 			category: "propertyVariable",
+			icon: style.lucideIcon ?? null,
 			styles: stylesByViewport
 		};
 	});

package/package.json

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