ochre-sdk 0.21.2 → 0.21.4

package/dist/index.d.mts

@@ -675,7 +675,7 @@ type SetItemsSort = {
  */
 type QueryLeaf = {
   target: "property";
-  propertyVariables?: Array<string>;
+  propertyVariable?: string;
   dataType: Exclude<Exclude<PropertyValueContentType, "coordinate">, "date" | "dateTime">;
   propertyValues?: Array<string>;
   from?: never;
@@ -686,9 +686,22 @@ type QueryLeaf = {
   isNegated?: boolean;
 } | {
   target: "property";
-  propertyVariables: Array<string>;
+  propertyVariable: string;
   dataType: "date" | "dateTime";
   propertyValues?: never;
+  value: string;
+  from?: never;
+  to?: never;
+  matchMode: "includes" | "exact";
+  isCaseSensitive: boolean;
+  language: string;
+  isNegated?: boolean;
+} | {
+  target: "property";
+  propertyVariable: string;
+  dataType: "date" | "dateTime";
+  propertyValues?: never;
+  value?: never;
   from: string;
   to?: string;
   matchMode: "includes" | "exact";
@@ -697,9 +710,10 @@ type QueryLeaf = {
   isNegated?: boolean;
 } | {
   target: "property";
-  propertyVariables: Array<string>;
+  propertyVariable: string;
   dataType: "date" | "dateTime";
   propertyValues?: never;
+  value?: never;
   from?: string;
   to: string;
   matchMode: "includes" | "exact";
@@ -793,6 +807,19 @@ type StylesheetItem = {
     mobile: Array<Style>;
   };
 };
+type WebsitePropertyQueryNode = {
+  target: "property";
+  propertyVariable: string;
+  dataType: Exclude<PropertyValueContentType, "coordinate">;
+  matchMode: "includes" | "exact";
+  isCaseSensitive: boolean;
+  language: string;
+};
+type WebsitePropertyQuery = WebsitePropertyQueryNode | {
+  and: Array<WebsitePropertyQuery>;
+} | {
+  or: Array<WebsitePropertyQuery>;
+};
 /**
  * Represents the OCHRE website type
  */
@@ -1089,9 +1116,9 @@ type WebElementComponent = {
 } | {
   component: "query";
   linkUuids: Array<string>;
-  queries: Array<{
+  items: Array<{
     label: string;
-    propertyVariableUuids: Array<string>;
+    queries: Array<WebsitePropertyQuery>;
     startIcon: string | null;
     endIcon: string | null;
   }>;
@@ -1503,4 +1530,4 @@ declare const DEFAULT_PAGE_SIZE = 48;
  */
 declare function flattenItemProperties<T extends DataCategory = DataCategory, U extends DataCategory | Array<DataCategory> = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? Array<DataCategory> : never)>(item: Item<T, U>): Item<T, U>;
 //#endregion
-export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Query, QueryGroup, QueryLeaf, Resource, Scope, Section, Set, SetAttributeValueQueryItem, SetItemsSort, SetItemsSortDirection, SpatialUnit, Style, StylesheetCategory, StylesheetItem, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsiteType, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Query, QueryGroup, QueryLeaf, Resource, Scope, Section, Set, SetAttributeValueQueryItem, SetItemsSort, SetItemsSortDirection, SpatialUnit, Style, StylesheetCategory, StylesheetItem, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteType, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/dist/index.mjs

@@ -759,7 +759,7 @@ const boundsSchema = z.string().transform((str, ctx) => {
 const setQueryLeafSchema = z.union([
 	z.object({
 		target: z.literal("property"),
-		propertyVariables: z.array(uuidSchema).default([]),
+		propertyVariable: uuidSchema.optional(),
 		dataType: z.enum([
 			"string",
 			"integer",
@@ -774,15 +774,28 @@ const setQueryLeafSchema = z.union([
 		language: z.string().default("eng"),
 		isNegated: z.boolean().optional().default(false)
 	}).strict().superRefine((value, ctx) => {
-		if (value.propertyVariables.length === 0 && value.propertyValues == null) ctx.addIssue({
+		if (value.propertyVariable == null && value.propertyValues == null) ctx.addIssue({
 			code: "custom",
 			message: "Property queries must include at least one propertyVariable or propertyValue"
 		});
 	}),
 	z.object({
 		target: z.literal("property"),
-		propertyVariables: z.array(uuidSchema).min(1, "At least one property variable UUID is required"),
+		propertyVariable: uuidSchema,
 		dataType: z.enum(["date", "dateTime"]),
+		value: z.string(),
+		from: z.never().optional(),
+		to: z.never().optional(),
+		matchMode: z.enum(["includes", "exact"]),
+		isCaseSensitive: z.boolean(),
+		language: z.string().default("eng"),
+		isNegated: z.boolean().optional().default(false)
+	}).strict(),
+	z.object({
+		target: z.literal("property"),
+		propertyVariable: uuidSchema,
+		dataType: z.enum(["date", "dateTime"]),
+		value: z.never().optional(),
 		from: z.string(),
 		to: z.string().optional(),
 		matchMode: z.enum(["includes", "exact"]),
@@ -792,8 +805,9 @@ const setQueryLeafSchema = z.union([
 	}).strict(),
 	z.object({
 		target: z.literal("property"),
-		propertyVariables: z.array(uuidSchema).min(1, "At least one property variable UUID is required"),
+		propertyVariable: uuidSchema,
 		dataType: z.enum(["date", "dateTime"]),
+		value: z.never().optional(),
 		from: z.string().optional(),
 		to: z.string(),
 		matchMode: z.enum(["includes", "exact"]),
@@ -854,11 +868,11 @@ const setItemsSortSchema = z.discriminatedUnion("target", [
 		language: z.string().default("eng")
 	}).strict()
 ]).default({ target: "none" });
-function hasPropertyQueryWithPropertyVariables(query) {
+function hasPropertyQueryWithPropertyVariable(query) {
 	if (query == null) return false;
-	if ("target" in query) return query.target === "property" && (query.propertyVariables?.length ?? 0) > 0;
+	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 (hasPropertyQueryWithPropertyVariables(groupQuery)) return true;
+	for (const groupQuery of groupQueries) if (hasPropertyQueryWithPropertyVariable(groupQuery)) return true;
 	return false;
 }
 /**
@@ -878,10 +892,10 @@ const setPropertyValuesParamsSchema = z.object({
 	}),
 	isLimitedToLeafPropertyValues: z.boolean().default(false)
 }).superRefine((value, ctx) => {
-	if (!hasPropertyQueryWithPropertyVariables(value.queries)) ctx.addIssue({
+	if (!hasPropertyQueryWithPropertyVariable(value.queries)) ctx.addIssue({
 		code: "custom",
 		path: ["queries"],
-		message: "At least one property query with propertyVariables is required"
+		message: "At least one property query with propertyVariable is required"
 	});
 });
 const setItemsParamsSchema = z.object({
@@ -2393,10 +2407,8 @@ function buildDateRangePredicate(params) {
 /**
 * Build a property label predicate for an XQuery string.
 */
-function buildPropertyLabelPredicate(propertyVariables) {
-	const labelPredicates = [];
-	for (const propertyVariable of propertyVariables) labelPredicates.push(`@uuid=${stringLiteral(propertyVariable)}`);
-	return `label[${buildOrPredicate(labelPredicates)}]`;
+function buildPropertyLabelPredicate(propertyVariable) {
+	return `label[@uuid=${stringLiteral(propertyVariable)}]`;
 }
 function buildOrCtsQueryExpression(queries) {
 	if (queries.length === 1) return queries[0] ?? "cts:false-query()";
@@ -2503,11 +2515,11 @@ function buildItemStringIncludesGroupMember(query) {
 	};
 }
 function buildPropertyStringIncludesGroupMember(query) {
-	const propertyVariables = query.propertyVariables ?? [];
+	const propertyVariable = query.propertyVariable;
 	const predicateParts = [];
 	const valueExpression = buildFlattenedContentValuesExpression(`value[not(@inherited="true")]/content[@xml:lang="${query.language}"]`);
 	const propertyValue = query.propertyValues[0] ?? "";
-	if (propertyVariables.length > 0) predicateParts.push(buildPropertyLabelPredicate(propertyVariables));
+	if (propertyVariable != null) predicateParts.push(buildPropertyLabelPredicate(propertyVariable));
 	return {
 		rawPredicate: buildPropertyPredicateExpression([...predicateParts, buildRawStringMatchPredicate({
 			valueExpression,
@@ -2714,10 +2726,11 @@ function buildPropertyClause(params) {
 	const { query, version, queryKey } = params;
 	const predicateParts = [];
 	const declarations = [];
-	const propertyVariables = query.propertyVariables ?? [];
+	const propertyVariable = query.propertyVariable;
 	let candidateQueryVar = null;
-	if (propertyVariables.length > 0) predicateParts.push(buildPropertyLabelPredicate(propertyVariables));
-	if (query.dataType === "date" || query.dataType === "dateTime") predicateParts.push(buildDateRangePredicate({
+	if (propertyVariable != null) predicateParts.push(buildPropertyLabelPredicate(propertyVariable));
+	if (query.dataType === "date" || query.dataType === "dateTime") if ("value" in query && query.value != null) predicateParts.push(`value/@rawValue = ${stringLiteral(query.value)}`);
+	else predicateParts.push(buildDateRangePredicate({
 		from: query.from,
 		to: query.to
 	}));
@@ -3257,7 +3270,7 @@ function getPropertyVariableUuidsFromQueries(queries) {
 	for (const query of pendingQueries) {
 		if ("target" in query) {
 			if (query.target !== "property") continue;
-			for (const propertyVariableUuid of query.propertyVariables ?? []) propertyVariableUuids.add(propertyVariableUuid);
+			if (query.propertyVariable != null) propertyVariableUuids.add(query.propertyVariable);
 			continue;
 		}
 		pendingQueries.push(..."and" in query ? query.and : query.or);
@@ -4250,25 +4263,37 @@ function parseWebElementProperties(componentProperty, elementResource) {
 		case "query": {
 			const setLinks = links.filter((link) => link.category === "set");
 			if (setLinks.every((link) => link.uuid === null)) throw new Error(`Set links not found for the following component: “${componentName}”`);
-			const queries = [];
+			const items = [];
 			if (componentProperty.properties.length === 0) throw new Error(`Query properties not found for the following component: “${componentName}”`);
-			for (const query of componentProperty.properties) {
-				const querySubProperties = query.properties;
+			for (const queryItem of componentProperty.properties) {
+				const querySubProperties = queryItem.properties;
 				const label = getPropertyValueByLabel(querySubProperties, "query-prompt");
 				if (label === null) continue;
-				const propertyVariableUuids = getPropertyByLabel(querySubProperties, "use-property")?.values.map((value) => value.uuid).filter((uuid) => uuid !== null) ?? [];
+				const queries = (getPropertyByLabel(querySubProperties, "use-property")?.values.filter((value) => value.uuid !== null) ?? []).map((propertyVariable) => {
+					if (propertyVariable.uuid === null) throw new Error(`Property variable UUID not found for the following component: “${componentName}”`);
+					const dataType = propertyVariable.dataType;
+					if (dataType === "coordinate") throw new Error(`Query prompts with data type "coordinate" are not supported for the following component: “${componentName}”`);
+					return {
+						target: "property",
+						propertyVariable: propertyVariable.uuid,
+						dataType,
+						matchMode: "exact",
+						isCaseSensitive: true,
+						language: "eng"
+					};
+				});
 				let startIcon = getPropertyValueByLabel(querySubProperties, "start-icon");
 				startIcon ??= null;
 				let endIcon = getPropertyValueByLabel(querySubProperties, "end-icon");
 				endIcon ??= null;
-				queries.push({
+				items.push({
 					label,
-					propertyVariableUuids,
+					queries,
 					startIcon,
 					endIcon
 				});
 			}
-			if (queries.length === 0) throw new Error(`No queries found for the following component: “${componentName}”`);
+			if (items.length === 0) throw new Error(`No queries found for the following component: “${componentName}”`);
 			const options = {
 				attributeFilters: {
 					bibliographies: elementResource.options?.filterBibliography ?? false,
@@ -4299,7 +4324,7 @@ function parseWebElementProperties(componentProperty, elementResource) {
 			properties = {
 				component: "query",
 				linkUuids: setLinks.map((link) => link.uuid).filter((uuid) => uuid !== null),
-				queries,
+				items,
 				options,
 				displayedProperties: displayedProperties?.values.filter((value) => value.uuid !== null).map((value) => ({
 					uuid: value.uuid,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "0.21.2",
+  "version": "0.21.4",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",
@@ -51,7 +51,7 @@
     "bumpp": "^11.0.1",
     "eslint": "^10.1.0",
     "prettier": "^3.8.1",
-    "tsdown": "^0.21.5",
+    "tsdown": "^0.21.7",
     "typescript": "^6.0.2"
   },
   "scripts": {