ochre-sdk 0.21.7 → 0.21.8

package/dist/index.d.mts

@@ -734,7 +734,7 @@ type QueryLeaf = {
   language: string;
   isNegated?: boolean;
 } | {
-  target: "title" | "description" | "image" | "periods" | "bibliography";
+  target: "title" | "description" | "image" | "periods" | "bibliography" | "notes";
   value: string;
   matchMode: "includes" | "exact";
   isCaseSensitive: boolean;

package/dist/index.mjs

@@ -839,7 +839,8 @@ const setQueryLeafSchema = z.union([
 			"description",
 			"image",
 			"periods",
-			"bibliography"
+			"bibliography",
+			"notes"
 		]),
 		value: z.string(),
 		matchMode: z.enum(["includes", "exact"]),
@@ -2196,6 +2197,23 @@ function buildCombinedSearchableContentNodesExpression(contentNodesExpressions)
 	if (searchableExpressions.length === 1) return searchableExpressions[0] ?? "()";
 	return `(${searchableExpressions.join(", ")})`;
 }
+function buildAttributeValuesExpression(params) {
+	const { nodeExpression, attributeName } = params;
+	return `for $node in ${nodeExpression}[@${attributeName}]
+    return string($node/@${attributeName})`;
+}
+function buildNotesContentNodesExpression(language) {
+	return `notes/note/content[@xml:lang="${language}"]`;
+}
+function buildNotesTitleValuesExpression(language) {
+	return buildAttributeValuesExpression({
+		nodeExpression: buildNotesContentNodesExpression(language),
+		attributeName: "title"
+	});
+}
+function buildNotesValueExpressions(language) {
+	return [buildFlattenedContentValuesExpression(buildNotesContentNodesExpression(language)), buildNotesTitleValuesExpression(language)];
+}
 function buildPropertyValueNodesExpression(params) {
 	const predicates = [];
 	if (params?.excludeInherited) predicates.push(`not(@inherited="true")`);
@@ -2577,12 +2595,37 @@ function buildPropertyScalarCandidateBranch(params) {
         )
       )`;
 }
+function buildNotesCandidateBranch(params) {
+	const { termExpression, isCaseSensitive, language } = params;
+	return `cts:element-query(xs:QName("notes"),
+        cts:element-query(xs:QName("note"),
+          cts:element-query(xs:QName("content"),
+            cts:and-query((
+              cts:element-attribute-value-query(xs:QName("content"), xs:QName("xml:lang"), ${stringLiteral(language)}),
+              cts:or-query((
+                ${buildCtsElementAttributeWordQueryExpression({
+		elementName: "content",
+		attributeName: "title",
+		termExpression,
+		isCaseSensitive
+	})},
+                ${buildCtsWordQueryExpression({
+		termExpression,
+		isCaseSensitive
+	})}
+              ))
+            ))
+          )
+        )
+      )`;
+}
 function getGroupableIncludesValue(query) {
 	switch (query.target) {
 		case "string":
 		case "title":
 		case "description":
 		case "image":
+		case "notes":
 		case "periods":
 		case "bibliography": return query.value;
 		case "property":
@@ -2657,6 +2700,21 @@ function buildPropertyStringIncludesGroupMember(query) {
 		})
 	};
 }
+function buildNotesIncludesGroupMember(query) {
+	return {
+		rawPredicate: buildCombinedRawStringMatchPredicate({
+			valueExpressions: buildNotesValueExpressions(query.language),
+			value: query.value,
+			matchMode: "includes",
+			isCaseSensitive: query.isCaseSensitive
+		}),
+		buildCandidateTermQuery: (termExpression) => buildNotesCandidateBranch({
+			termExpression,
+			isCaseSensitive: query.isCaseSensitive,
+			language: query.language
+		})
+	};
+}
 function buildIncludesGroupMember(query) {
 	switch (query.target) {
 		case "string": return buildItemStringIncludesGroupMember(query);
@@ -2695,6 +2753,7 @@ function buildIncludesGroupMember(query) {
 			language: query.language,
 			containerElementName: "image"
 		});
+		case "notes": return buildNotesIncludesGroupMember(query);
 		case "property":
 			if (query.dataType === "all") throw new Error(`Property queries with dataType "all" are not compatible with includes-group optimization`);
 			return buildPropertyStringIncludesGroupMember(query);
@@ -2876,6 +2935,23 @@ function buildPropertyAllValueClause(query) {
 		candidateQueryVar: null
 	};
 }
+function buildNotesValueClause(params) {
+	const { query, version, queryKey, allowCtsPredicates } = params;
+	return buildCombinedRawStringMatchClause({
+		valueExpressions: buildNotesValueExpressions(query.language),
+		value: query.value,
+		matchMode: query.matchMode,
+		isCaseSensitive: query.isCaseSensitive,
+		version,
+		queryKey,
+		allowCtsPredicates,
+		buildCandidateTermQuery: (termExpression) => buildNotesCandidateBranch({
+			termExpression,
+			isCaseSensitive: query.isCaseSensitive,
+			language: query.language
+		})
+	});
+}
 /**
 * Build a property predicate for an XQuery string.
 */
@@ -3037,6 +3113,12 @@ function buildQueryClause(params) {
 				language: query.language
 			})
 		});
+		case "notes": return buildNotesValueClause({
+			query,
+			version,
+			queryKey,
+			allowCtsPredicates
+		});
 		case "property": return buildPropertyClause({
 			query,
 			version,

package/package.json

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